is-what 4.1.15 → 4.1.16

package/dist/index.d.ts

@@ -1,334 +1,380 @@
-type AnyFunction = (...args: any[]) => any;
-type AnyAsyncFunction = (...args: any[]) => Promise<any>;
-type AnyClass = new (...args: any[]) => any;
-type PlainObject = Record<string | number | symbol, any>;
-type TypeGuard<A, B extends A> = (payload: A) => payload is B;
 /**
  * Returns the object type of the given payload
  *
- * @param {*} payload
+ * @param {any} payload
  * @returns {string}
  */
 declare function getType(payload: any): string;
+
+type PlainObject = Record<string | number | symbol, any>;
 /**
- * Returns whether the payload is undefined
+ * Returns whether the payload is a plain JavaScript object (excluding special classes or objects
+ * with other prototypes)
  *
- * @param {*} payload
- * @returns {payload is undefined}
+ * @param {any} payload
+ * @returns {payload is PlainObject}
  */
-declare function isUndefined(payload: any): payload is undefined;
+declare function isPlainObject(payload: any): payload is PlainObject;
+
 /**
- * Returns whether the payload is null
+ * Returns whether the payload is an any kind of object (including special classes or objects with
+ * different prototypes)
  *
- * @param {*} payload
- * @returns {payload is null}
+ * @param {any} payload
+ * @returns {payload is PlainObject}
  */
-declare function isNull(payload: any): payload is null;
+declare function isAnyObject(payload: any): payload is PlainObject;
+
 /**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
+ * Returns whether the payload is an array
  *
- * @param {*} payload
- * @returns {payload is PlainObject}
+ * @param {any} payload
+ * @returns {payload is any[]}
  */
-declare function isPlainObject(payload: any): payload is PlainObject;
+declare function isArray(payload: any): payload is any[];
+
 /**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
+ * Returns whether the payload is a Blob
  *
- * @param {*} payload
- * @returns {payload is PlainObject}
+ * @param {any} payload
+ * @returns {payload is Blob}
  */
-declare function isObject(payload: any): payload is PlainObject;
+declare function isBlob(payload: any): payload is Blob;
+
 /**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
+ * Returns whether the payload is a boolean
  *
- * @param {*} payload
- * @returns {payload is { [K in any]: never }}
+ * @param {any} payload
+ * @returns {payload is boolean}
  */
-declare function isEmptyObject(payload: any): payload is {
-    [K in any]: never;
-};
+declare function isBoolean(payload: any): payload is boolean;
+
 /**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
+ * Returns whether the payload is a Date, and that the date is valid
  *
- * @param {*} payload
- * @returns {payload is PlainObject}
+ * @param {any} payload
+ * @returns {payload is Date}
  */
-declare function isFullObject(payload: any): payload is PlainObject;
+declare function isDate(payload: any): payload is Date;
+
 /**
- * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
+ * Returns whether the payload is a an empty array
  *
- * @param {*} payload
- * @returns {payload is PlainObject}
+ * @param {any} payload
+ * @returns {payload is []}
  */
-declare function isAnyObject(payload: any): payload is PlainObject;
+declare function isEmptyArray(payload: any): payload is [];
+
 /**
- * Returns whether the payload is an object like a type passed in < >
+ * Returns whether the payload is a an empty object (excluding special classes or objects with other
+ * prototypes)
  *
- * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
+ * @param {any} payload
+ * @returns {payload is { [K in any]: never }}
+ */
+declare function isEmptyObject(payload: any): payload is {
+    [K in any]: never;
+};
+
+/**
+ * Returns whether the payload is ''
  *
- * @template T this must be passed in < >
- * @param {*} payload
- * @returns {payload is T}
+ * @param {any} payload
+ * @returns {payload is string}
  */
-declare function isObjectLike<T extends PlainObject>(payload: any): payload is T;
+declare function isEmptyString(payload: any): payload is string;
+
 /**
- * Returns whether the payload is a function (regular or async)
+ * Returns whether the payload is an Error
  *
- * @param {*} payload
- * @returns {payload is AnyFunction}
+ * @param {any} payload
+ * @returns {payload is Error}
  */
-declare function isFunction(payload: any): payload is AnyFunction;
+declare function isError(payload: any): payload is Error;
+
 /**
- * Returns whether the payload is an array
+ * Returns whether the payload is a File
  *
  * @param {any} payload
- * @returns {payload is any[]}
+ * @returns {payload is File}
  */
-declare function isArray(payload: any): payload is any[];
+declare function isFile(payload: any): payload is File;
+
 /**
  * Returns whether the payload is a an array with at least 1 item
  *
- * @param {*} payload
+ * @param {any} payload
  * @returns {payload is any[]}
  */
 declare function isFullArray(payload: any): payload is any[];
+
 /**
- * Returns whether the payload is a an empty array
+ * Returns whether the payload is a an empty object (excluding special classes or objects with other
+ * prototypes)
  *
- * @param {*} payload
- * @returns {payload is []}
+ * @param {any} payload
+ * @returns {payload is PlainObject}
  */
-declare function isEmptyArray(payload: any): payload is [];
+declare function isFullObject(payload: any): payload is PlainObject;
+
 /**
- * Returns whether the payload is a string
+ * Returns whether the payload is a string, BUT returns false for ''
  *
- * @param {*} payload
+ * @param {any} payload
  * @returns {payload is string}
  */
-declare function isString(payload: any): payload is string;
+declare function isFullString(payload: any): payload is string;
+
+type AnyFunction = (...args: any[]) => any;
 /**
- * Returns whether the payload is a string, BUT returns false for ''
+ * Returns whether the payload is a function (regular or async)
  *
- * @param {*} payload
- * @returns {payload is string}
+ * @param {any} payload
+ * @returns {payload is AnyFunction}
  */
-declare function isFullString(payload: any): payload is string;
+declare function isFunction(payload: any): payload is AnyFunction;
+
+type AnyClass = new (...args: any[]) => any;
 /**
- * Returns whether the payload is ''
+ * Does a generic check to check that the given payload is of a given type. In cases like Number, it
+ * will return true for NaN as NaN is a Number (thanks javascript!); It will, however, differentiate
+ * between object and null
  *
- * @param {*} payload
- * @returns {payload is string}
+ * @template T
+ * @param {any} payload
+ * @param {T} type
+ * @returns {payload is T}
+ * @throws {TypeError} Will throw type error if type is an invalid type
  */
-declare function isEmptyString(payload: any): payload is string;
+declare function isType<T extends AnyFunction | AnyClass>(payload: any, type: T): payload is T;
+
+type GlobalClassName = {
+    [K in keyof typeof globalThis]: (typeof globalThis)[K] extends AnyClass ? K : never;
+}[keyof typeof globalThis];
 /**
- * Returns whether the payload is a number (but not NaN)
+ * Checks if a value is an instance of a class or a class name. Useful when you want to check if a
+ * value is an instance of a class that may not be defined in the current scope. For example, if you
+ * want to check if a value is an `OffscreenCanvas` instance, you might not want to do the song and
+ * dance of using `typeof OffscreenCanvas !== 'undefined'` and then shimming `OffscreenCanvas` if
+ * the types aren't around.
  *
- * This will return `false` for `NaN`!!
+ * @example
+ *   if (isInstanceOf(value, 'OffscreenCanvas')) {
+ *     // value is an OffscreenCanvas
+ *   }
  *
- * @param {*} payload
- * @returns {payload is number}
+ * @param value The value to recursively check
+ * @param class_ A string or class that the value should be an instance of
  */
-declare function isNumber(payload: any): payload is number;
+declare function isInstanceOf<T extends AnyClass>(value: unknown, class_: T): value is T;
+declare function isInstanceOf<K extends GlobalClassName>(value: unknown, className: K): value is (typeof globalThis)[K];
+declare function isInstanceOf(value: unknown, className: string): value is object;
+
 /**
- * Returns whether the payload is a positive number (but not 0)
+ * Returns whether the payload is a Map
  *
- * @param {*} payload
- * @returns {payload is number}
+ * @param {any} payload
+ * @returns {payload is Map<any, any>}
  */
-declare function isPositiveNumber(payload: any): payload is number;
+declare function isMap(payload: any): payload is Map<any, any>;
+
+/**
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
+ *
+ * @param {any} payload
+ * @returns {payload is typeof NaN}
+ */
+declare function isNaNValue(payload: any): payload is typeof NaN;
+
 /**
  * Returns whether the payload is a negative number (but not 0)
  *
- * @param {*} payload
+ * @param {any} payload
  * @returns {payload is number}
  */
 declare function isNegativeNumber(payload: any): payload is number;
+
 /**
- * Returns whether the payload is a boolean
+ * Returns whether the payload is null
  *
- * @param {*} payload
- * @returns {payload is boolean}
+ * @param {any} payload
+ * @returns {payload is null}
  */
-declare function isBoolean(payload: any): payload is boolean;
+declare function isNull(payload: any): payload is null;
+
 /**
- * Returns whether the payload is a regular expression (RegExp)
+ * Returns true whether the payload is null or undefined
  *
- * @param {*} payload
- * @returns {payload is RegExp}
+ * @param {any} payload
+ * @returns {(payload is null | undefined)}
  */
-declare function isRegExp(payload: any): payload is RegExp;
+declare const isNullOrUndefined: (payload: any) => payload is null | undefined;
+
 /**
- * Returns whether the payload is a Map
+ * Returns whether the payload is a number (but not NaN)
  *
- * @param {*} payload
- * @returns {payload is Map<any, any>}
- */
-declare function isMap(payload: any): payload is Map<any, any>;
-/**
- * Returns whether the payload is a WeakMap
+ * This will return `false` for `NaN`!!
  *
- * @param {*} payload
- * @returns {payload is WeakMap<any, any>}
+ * @param {any} payload
+ * @returns {payload is number}
  */
-declare function isWeakMap(payload: any): payload is WeakMap<any, any>;
+declare function isNumber(payload: any): payload is number;
+
 /**
- * Returns whether the payload is a Set
+ * Returns whether the payload is a plain JavaScript object (excluding special classes or objects
+ * with other prototypes)
  *
- * @param {*} payload
- * @returns {payload is Set<any>}
+ * @param {any} payload
+ * @returns {payload is PlainObject}
  */
-declare function isSet(payload: any): payload is Set<any>;
+declare function isObject(payload: any): payload is PlainObject;
+
 /**
- * Returns whether the payload is a WeakSet
+ * Returns whether the payload is an object like a type passed in < >
  *
- * @param {*} payload
- * @returns {payload is WeakSet<any>}
- */
-declare function isWeakSet(payload: any): payload is WeakSet<any>;
-/**
- * Returns whether the payload is a Symbol
+ * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
  *
- * @param {*} payload
- * @returns {payload is symbol}
+ * @template T This must be passed in < >
+ * @param {any} payload
+ * @returns {payload is T}
  */
-declare function isSymbol(payload: any): payload is symbol;
+declare function isObjectLike<T extends PlainObject>(payload: any): payload is T;
+
+type TypeGuard<A, B extends A> = (payload: A) => payload is B;
 /**
- * Returns whether the payload is a Date, and that the date is valid
+ * A factory function that creates a function to check if the payload is one of the given types.
  *
- * @param {*} payload
- * @returns {payload is Date}
- */
-declare function isDate(payload: any): payload is Date;
-/**
- * Returns whether the payload is a Blob
+ * @example
+ *   import { isOneOf, isNull, isUndefined } from 'is-what'
  *
- * @param {*} payload
- * @returns {payload is Blob}
+ *   const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ *   isNullOrUndefined(null) // true
+ *   isNullOrUndefined(undefined) // true
+ *   isNullOrUndefined(123) // false
  */
-declare function isBlob(payload: any): payload is Blob;
+declare function isOneOf<A, B extends A, C extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>): TypeGuard<A, B | C>;
 /**
- * Returns whether the payload is a File
+ * A factory function that creates a function to check if the payload is one of the given types.
  *
- * @param {*} payload
- * @returns {payload is File}
+ * @example
+ *   import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ *   const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ *   isNullOrUndefined(null) // true
+ *   isNullOrUndefined(undefined) // true
+ *   isNullOrUndefined(123) // false
  */
-declare function isFile(payload: any): payload is File;
+declare 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>;
 /**
- * Returns whether the payload is a Promise
+ * A factory function that creates a function to check if the payload is one of the given types.
  *
- * @param {*} payload
- * @returns {payload is Promise<any>}
+ * @example
+ *   import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ *   const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ *   isNullOrUndefined(null) // true
+ *   isNullOrUndefined(undefined) // true
+ *   isNullOrUndefined(123) // false
  */
-declare function isPromise(payload: any): payload is Promise<any>;
+declare 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>;
 /**
- * Returns whether the payload is an Error
+ * A factory function that creates a function to check if the payload is one of the given types.
  *
- * @param {*} payload
- * @returns {payload is Error}
+ * @example
+ *   import { isOneOf, isNull, isUndefined } from 'is-what'
+ *
+ *   const isNullOrUndefined = isOneOf(isNull, isUndefined)
+ *
+ *   isNullOrUndefined(null) // true
+ *   isNullOrUndefined(undefined) // true
+ *   isNullOrUndefined(123) // false
  */
-declare function isError(payload: any): payload is Error;
+declare 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>;
+
 /**
- * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
+ * Returns whether the payload is a positive number (but not 0)
  *
- * @param {*} payload
- * @returns {payload is typeof NaN}
+ * @param {any} payload
+ * @returns {payload is number}
  */
-declare function isNaNValue(payload: any): payload is typeof NaN;
+declare function isPositiveNumber(payload: any): payload is number;
+
 /**
- * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
+ * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String
+ * | Symbol)
  *
- * @param {*} payload
+ * @param {any} payload
  * @returns {(payload is boolean | null | undefined | number | string | symbol)}
  */
 declare function isPrimitive(payload: any): payload is boolean | null | undefined | number | string | symbol;
+
 /**
- * Returns true whether the payload is null or undefined
+ * Returns whether the payload is a Promise
  *
- * @param {*} payload
- * @returns {(payload is null | undefined)}
+ * @param {any} payload
+ * @returns {payload is Promise<any>}
  */
-declare const isNullOrUndefined: TypeGuard<any, null | undefined>;
+declare function isPromise(payload: any): payload is Promise<any>;
+
 /**
- * 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)
+ * Returns whether the payload is a regular expression (RegExp)
  *
- * isNullOrUndefined(null) // true
- * isNullOrUndefined(undefined) // true
- * isNullOrUndefined(123) // false
+ * @param {any} payload
+ * @returns {payload is RegExp}
  */
-declare function isOneOf<A, B extends A, C extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>): TypeGuard<A, B | C>;
+declare function isRegExp(payload: any): payload is RegExp;
+
 /**
- * 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)
+ * Returns whether the payload is a Set
  *
- * isNullOrUndefined(null) // true
- * isNullOrUndefined(undefined) // true
- * isNullOrUndefined(123) // false
+ * @param {any} payload
+ * @returns {payload is Set<any>}
  */
-declare 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>;
+declare function isSet(payload: any): payload is Set<any>;
+
 /**
- * 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)
+ * Returns whether the payload is a string
  *
- * isNullOrUndefined(null) // true
- * isNullOrUndefined(undefined) // true
- * isNullOrUndefined(123) // false
+ * @param {any} payload
+ * @returns {payload is string}
  */
-declare 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>;
+declare function isString(payload: any): payload is string;
+
 /**
- * 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)
+ * Returns whether the payload is a Symbol
  *
- * isNullOrUndefined(null) // true
- * isNullOrUndefined(undefined) // true
- * isNullOrUndefined(123) // false
+ * @param {any} payload
+ * @returns {payload is symbol}
  */
-declare 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>;
+declare function isSymbol(payload: any): payload is symbol;
+
 /**
- * Does a generic check to check that the given payload is of a given type.
- * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
- * It will, however, differentiate between object and null
+ * Returns whether the payload is undefined
  *
- * @template T
- * @param {*} payload
- * @param {T} type
- * @throws {TypeError} Will throw type error if type is an invalid type
- * @returns {payload is T}
+ * @param {any} payload
+ * @returns {payload is undefined}
  */
-declare function isType<T extends AnyFunction | AnyClass>(payload: any, type: T): payload is T;
-type GlobalClassName = {
-    [K in keyof typeof globalThis]: (typeof globalThis)[K] extends AnyClass ? K : never;
-}[keyof typeof globalThis];
+declare function isUndefined(payload: any): payload is undefined;
+
 /**
- * Checks if a value is an instance of a class or a class name. Useful when you
- * want to check if a value is an instance of a class that may not be defined in
- * the current scope. For example, if you want to check if a value is an
- * `OffscreenCanvas` instance, you might not want to do the song and dance of
- * using `typeof OffscreenCanvas !== 'undefined'` and then shimming
- * `OffscreenCanvas` if the types aren't around.
+ * Returns whether the payload is a WeakMap
  *
- * @example
- * if (isInstanceOf(value, 'OffscreenCanvas')) {
- *  // value is an OffscreenCanvas
- * }
+ * @param {any} payload
+ * @returns {payload is WeakMap<any, any>}
+ */
+declare function isWeakMap(payload: any): payload is WeakMap<any, any>;
+
+/**
+ * Returns whether the payload is a WeakSet
  *
- * @param value The value to recursively check
- * @param class_ A string or class that the value should be an instance of
+ * @param {any} payload
+ * @returns {payload is WeakSet<any>}
  */
-declare function isInstanceOf<T extends AnyClass>(value: unknown, class_: T): value is T;
-declare function isInstanceOf<K extends GlobalClassName>(value: unknown, className: K): value is (typeof globalThis)[K];
-declare function isInstanceOf(value: unknown, className: string): value is object;
+declare function isWeakSet(payload: any): payload is WeakSet<any>;
+
+type AnyAsyncFunction = (...args: any[]) => Promise<any>;
 
 export { AnyAsyncFunction, AnyClass, AnyFunction, PlainObject, getType, isAnyObject, isArray, isBlob, isBoolean, isDate, isEmptyArray, isEmptyObject, isEmptyString, isError, isFile, isFullArray, isFullObject, isFullString, isFunction, isInstanceOf, isMap, isNaNValue, isNegativeNumber, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isOneOf, isPlainObject, isPositiveNumber, isPrimitive, isPromise, isRegExp, isSet, isString, isSymbol, isType, isUndefined, isWeakMap, isWeakSet };