Skip to content

Commit 51c52ba

Browse files
committed
docs: add @inheritdoc to attributes of as and is
1 parent 7d8bcbd commit 51c52ba

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

as/mod.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ import { asReadonly, asUnreadonly } from "./readonly.ts";
55
* Annotation collection for object predicate properties.
66
*/
77
export const as = {
8+
/** @inheritdoc */
89
Optional: asOptional,
10+
/** @inheritdoc */
911
Readonly: asReadonly,
12+
/** @inheritdoc */
1013
Unoptional: asUnoptional,
14+
/** @inheritdoc */
1115
Unreadonly: asUnreadonly,
1216
};

is/mod.ts

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,43 +42,82 @@ import { isUnknown } from "./unknown.ts";
4242
* Type predicate function collection.
4343
*/
4444
export const is = {
45+
/** @inheritdoc */
4546
Any: isAny,
47+
/** @inheritdoc */
4648
Array: isArray,
49+
/** @inheritdoc */
4750
ArrayOf: isArrayOf,
51+
/** @inheritdoc */
4852
AsyncFunction: isAsyncFunction,
53+
/** @inheritdoc */
4954
Bigint: isBigint,
55+
/** @inheritdoc */
5056
Boolean: isBoolean,
57+
/** @inheritdoc */
5158
Function: isFunction,
59+
/** @inheritdoc */
5260
InstanceOf: isInstanceOf,
61+
/** @inheritdoc */
5362
IntersectionOf: isIntersectionOf,
63+
/** @inheritdoc */
5464
LiteralOf: isLiteralOf,
65+
/** @inheritdoc */
5566
LiteralOneOf: isLiteralOneOf,
67+
/** @inheritdoc */
5668
Map: isMap,
69+
/** @inheritdoc */
5770
MapOf: isMapOf,
71+
/** @inheritdoc */
5872
Null: isNull,
73+
/** @inheritdoc */
5974
Nullish: isNullish,
75+
/** @inheritdoc */
6076
Number: isNumber,
77+
/** @inheritdoc */
6178
ObjectOf: isObjectOf,
79+
/** @inheritdoc */
6280
OmitOf: isOmitOf,
81+
/** @inheritdoc */
6382
ParametersOf: isParametersOf,
83+
/** @inheritdoc */
6484
PartialOf: isPartialOf,
85+
/** @inheritdoc */
6586
PickOf: isPickOf,
87+
/** @inheritdoc */
6688
Primitive: isPrimitive,
89+
/** @inheritdoc */
6790
ReadonlyOf: isReadonlyOf,
91+
/** @inheritdoc */
6892
Record: isRecord,
93+
/** @inheritdoc */
6994
RecordObject: isRecordObject,
95+
/** @inheritdoc */
7096
RecordObjectOf: isRecordObjectOf,
97+
/** @inheritdoc */
7198
RecordOf: isRecordOf,
99+
/** @inheritdoc */
72100
RequiredOf: isRequiredOf,
101+
/** @inheritdoc */
73102
Set: isSet,
103+
/** @inheritdoc */
74104
SetOf: isSetOf,
105+
/** @inheritdoc */
75106
StrictOf: isStrictOf,
107+
/** @inheritdoc */
76108
String: isString,
109+
/** @inheritdoc */
77110
Symbol: isSymbol,
111+
/** @inheritdoc */
78112
SyncFunction: isSyncFunction,
113+
/** @inheritdoc */
79114
TupleOf: isTupleOf,
115+
/** @inheritdoc */
80116
Undefined: isUndefined,
117+
/** @inheritdoc */
81118
UniformTupleOf: isUniformTupleOf,
119+
/** @inheritdoc */
82120
UnionOf: isUnionOf,
121+
/** @inheritdoc */
83122
Unknown: isUnknown,
84123
} as const;

0 commit comments

Comments
 (0)