feat: add JSDocs

mesqueeb · May 31, 2023 · 6977a30 · 6977a30
1 parent f3c8b3c
commit 6977a30
Showing 1 changed file with 55 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -359,28 +359,83 @@ export function isPrimitive(
  */
 export const isNullOrUndefined = isOneOf(isNull, isUndefined)
 
+/**
+ * A factory function that creates a function to check if the payload is one of the given types.
+ * @example
+ * import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ * const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ * isNullOrUndefined(null) // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(123) // false
+ */
 export function isOneOf<A, B extends A, C extends A>(
   a: TypeGuard<A, B>,
   b: TypeGuard<A, C>
 ): TypeGuard<A, B | C>
+/**
+ * A factory function that creates a function to check if the payload is one of the given types.
+ * @example
+ * import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ * const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ * isNullOrUndefined(null) // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(123) // false
+ */
 export function isOneOf<A, B extends A, C extends A, D extends A>(
   a: TypeGuard<A, B>,
   b: TypeGuard<A, C>,
   c: TypeGuard<A, D>
 ): TypeGuard<A, B | C | D>
+/**
+ * A factory function that creates a function to check if the payload is one of the given types.
+ * @example
+ * import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ * const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ * isNullOrUndefined(null) // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(123) // false
+ */
 export function isOneOf<A, B extends A, C extends A, D extends A, E extends A>(
   a: TypeGuard<A, B>,
   b: TypeGuard<A, C>,
   c: TypeGuard<A, D>,
   d: TypeGuard<A, E>
 ): TypeGuard<A, B | C | D | E>
+/**
+ * A factory function that creates a function to check if the payload is one of the given types.
+ * @example
+ * import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ * const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ * isNullOrUndefined(null) // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(123) // false
+ */
 export function isOneOf<A, B extends A, C extends A, D extends A, E extends A, F extends A>(
   a: TypeGuard<A, B>,
   b: TypeGuard<A, C>,
   c: TypeGuard<A, D>,
   d: TypeGuard<A, E>,
   e: TypeGuard<A, F>
 ): TypeGuard<A, B | C | D | E | F>
+/**
+ * A factory function that creates a function to check if the payload is one of the given types.
+ * @example
+ * import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ * const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ * isNullOrUndefined(null) // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(123) // false
+ */
 export function isOneOf(
   a: AnyFunction,
   b: AnyFunction,