Skip to content

Commit

Permalink
docs: add @inheritdoc to attributes of as and is
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Aug 8, 2024
1 parent 7d8bcbd commit 51c52ba
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
4 changes: 4 additions & 0 deletions as/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ import { asReadonly, asUnreadonly } from "./readonly.ts";
* Annotation collection for object predicate properties.
*/
export const as = {
/** @inheritdoc */
Optional: asOptional,
/** @inheritdoc */
Readonly: asReadonly,
/** @inheritdoc */
Unoptional: asUnoptional,
/** @inheritdoc */
Unreadonly: asUnreadonly,
};
39 changes: 39 additions & 0 deletions is/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,43 +42,82 @@ import { isUnknown } from "./unknown.ts";
* Type predicate function collection.
*/
export const is = {
/** @inheritdoc */
Any: isAny,
/** @inheritdoc */
Array: isArray,
/** @inheritdoc */
ArrayOf: isArrayOf,
/** @inheritdoc */
AsyncFunction: isAsyncFunction,
/** @inheritdoc */
Bigint: isBigint,
/** @inheritdoc */
Boolean: isBoolean,
/** @inheritdoc */
Function: isFunction,
/** @inheritdoc */
InstanceOf: isInstanceOf,
/** @inheritdoc */
IntersectionOf: isIntersectionOf,
/** @inheritdoc */
LiteralOf: isLiteralOf,
/** @inheritdoc */
LiteralOneOf: isLiteralOneOf,
/** @inheritdoc */
Map: isMap,
/** @inheritdoc */
MapOf: isMapOf,
/** @inheritdoc */
Null: isNull,
/** @inheritdoc */
Nullish: isNullish,
/** @inheritdoc */
Number: isNumber,
/** @inheritdoc */
ObjectOf: isObjectOf,
/** @inheritdoc */
OmitOf: isOmitOf,
/** @inheritdoc */
ParametersOf: isParametersOf,
/** @inheritdoc */
PartialOf: isPartialOf,
/** @inheritdoc */
PickOf: isPickOf,
/** @inheritdoc */
Primitive: isPrimitive,
/** @inheritdoc */
ReadonlyOf: isReadonlyOf,
/** @inheritdoc */
Record: isRecord,
/** @inheritdoc */
RecordObject: isRecordObject,
/** @inheritdoc */
RecordObjectOf: isRecordObjectOf,
/** @inheritdoc */
RecordOf: isRecordOf,
/** @inheritdoc */
RequiredOf: isRequiredOf,
/** @inheritdoc */
Set: isSet,
/** @inheritdoc */
SetOf: isSetOf,
/** @inheritdoc */
StrictOf: isStrictOf,
/** @inheritdoc */
String: isString,
/** @inheritdoc */
Symbol: isSymbol,
/** @inheritdoc */
SyncFunction: isSyncFunction,
/** @inheritdoc */
TupleOf: isTupleOf,
/** @inheritdoc */
Undefined: isUndefined,
/** @inheritdoc */
UniformTupleOf: isUniformTupleOf,
/** @inheritdoc */
UnionOf: isUnionOf,
/** @inheritdoc */
Unknown: isUnknown,
} as const;

0 comments on commit 51c52ba

Please sign in to comment.