From 51c52ba2caa5b991e15d25e17e29625402b66d01 Mon Sep 17 00:00:00 2001 From: Alisue Date: Thu, 8 Aug 2024 11:39:24 +0900 Subject: [PATCH 1/3] docs: add `@inheritdoc` to attributes of `as` and `is` --- as/mod.ts | 4 ++++ is/mod.ts | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/as/mod.ts b/as/mod.ts index 0f46786..07bdeab 100644 --- a/as/mod.ts +++ b/as/mod.ts @@ -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, }; diff --git a/is/mod.ts b/is/mod.ts index f99ba41..284c335 100644 --- a/is/mod.ts +++ b/is/mod.ts @@ -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; From 152d039b54fc75cb072b1f68078f74116eca202a Mon Sep 17 00:00:00 2001 From: Alisue Date: Thu, 8 Aug 2024 11:44:48 +0900 Subject: [PATCH 2/3] try --- is/mod.ts | 80 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 41 insertions(+), 39 deletions(-) diff --git a/is/mod.ts b/is/mod.ts index 284c335..b0317de 100644 --- a/is/mod.ts +++ b/is/mod.ts @@ -40,84 +40,86 @@ import { isUnknown } from "./unknown.ts"; /** * Type predicate function collection. + * + * @namespace + * @borrows isAny as Any + * @borrows isArray as Array + * @borrows isArrayOf as ArrayOf + * @borrows isAsyncFunction as AsyncFunction + * @borrows isBigint as Bigint + * @borrows isBoolean as Boolean + * @borrows isFunction as Function + * @borrows isInstanceOf as InstanceOf + * @borrows isIntersectionOf as IntersectionOf + * @borrows isLiteralOf as LiteralOf + * @borrows isLiteralOneOf as LiteralOneOf + * @borrows isMap as Map + * @borrows isMapOf as MapOf + * @borrows isNull as Null + * @borrows isNullish as Nullish + * @borrows isNumber as Number + * @borrows isObjectOf as ObjectOf + * @borrows isOmitOf as OmitOf + * @borrows isParametersOf as ParametersOf + * @borrows isPartialOf as PartialOf + * @borrows isPickOf as PickOf + * @borrows isPrimitive as Primitive + * @borrows isReadonlyOf as ReadonlyOf + * @borrows isRecord as Record + * @borrows isRecordObject as RecordObject + * @borrows isRecordObjectOf as RecordObjectOf + * @borrows isRecordOf as RecordOf + * @borrows isRequiredOf as RequiredOf + * @borrows isSet as Set + * @borrows isSetOf as SetOf + * @borrows isStrictOf as StrictOf + * @borrows isString as String + * @borrows isSymbol as Symbol + * @borrows isSyncFunction as SyncFunction + * @borrows isTupleOf as TupleOf + * @borrows isUndefined as Undefined + * @borrows isUniformTupleOf as UniformTupleOf + * @borrows isUnionOf as UnionOf + * @borrows isUnknown as Unknown */ 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; From 02ec567a58b0c639e53081bcb63712611c78de05 Mon Sep 17 00:00:00 2001 From: Alisue Date: Thu, 8 Aug 2024 11:52:09 +0900 Subject: [PATCH 3/3] try --- is/mod.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/is/mod.ts b/is/mod.ts index b0317de..528027a 100644 --- a/is/mod.ts +++ b/is/mod.ts @@ -42,8 +42,8 @@ import { isUnknown } from "./unknown.ts"; * Type predicate function collection. * * @namespace - * @borrows isAny as Any - * @borrows isArray as Array + * @borrows module:unknownutil/is/any.isAny as Any + * @borrows {@link module:unknownutil/is/any.isArray} as Array * @borrows isArrayOf as ArrayOf * @borrows isAsyncFunction as AsyncFunction * @borrows isBigint as Bigint