what-are-you 0.1.7 → 0.1.9

package/dist/esm/prototypes.d.ts

@@ -0,0 +1,6 @@
+import { AnyCtor } from "./ctor-type.js";
+export declare const isInstanceOf: <Parent extends object>(instance: object, what: AnyCtor<Parent>) => instance is Parent;
+/** Return true when `obj` looks like the prototype object of some constructor. */
+export declare function isPrototypeObject(obj: object): boolean;
+export declare function getPrototypeChain<T>(obj: T, depth: number): T[];
+//# sourceMappingURL=prototypes.d.ts.map

package/dist/esm/prototypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prototypes.d.ts","sourceRoot":"","sources":["../../src/prototypes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAWxC,eAAO,MAAM,YAAY,GAAI,MAAM,SAAS,MAAM,EAC9C,UAAU,MAAM,EAChB,MAAM,OAAO,CAAC,MAAM,CAAC,KACtB,QAAQ,IAAI,MAEd,CAAA;AAED,kFAAkF;AAClF,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAYtD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,CAa/D"}

package/dist/esm/prototypes.js

@@ -0,0 +1,37 @@
+import { isFunction, isObject } from "lodash";
+const sCtor = "constructor";
+const sPrototype = "prototype";
+function getCtor(obj) {
+    return obj[sCtor];
+}
+function getCtorProto(obj) {
+    return obj[sPrototype];
+}
+export const isInstanceOf = (instance, what) => {
+    return instance instanceof what;
+};
+/** Return true when `obj` looks like the prototype object of some constructor. */
+export function isPrototypeObject(obj) {
+    if (!isObject(obj)) {
+        return false;
+    }
+    if (!Object.hasOwn(obj, sCtor)) {
+        return false;
+    }
+    const ctor = getCtor(obj);
+    const ctorPtoto = getCtorProto(ctor);
+    return isFunction(ctor) && ctorPtoto === obj && isInstanceOf(obj, ctor);
+}
+export function getPrototypeChain(obj, depth) {
+    const chain = [];
+    let current = obj;
+    while (current) {
+        if (depth <= 0) {
+            break;
+        }
+        chain.push(current);
+        current = Object.getPrototypeOf(current);
+    }
+    return chain;
+}
+//# sourceMappingURL=prototypes.js.map

package/dist/esm/prototypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prototypes.js","sourceRoot":"","sources":["../../src/prototypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAG7C,MAAM,KAAK,GAAG,aAAa,CAAA;AAC3B,MAAM,UAAU,GAAG,WAAW,CAAA;AAE9B,SAAS,OAAO,CAAmB,GAAM;IACrC,OAAO,GAAG,CAAC,KAAK,CAAe,CAAA;AACnC,CAAC;AACD,SAAS,YAAY,CAAqB,GAAM;IAC5C,OAAO,GAAG,CAAC,UAAU,CAAM,CAAA;AAC/B,CAAC;AACD,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,QAAgB,EAChB,IAAqB,EACH,EAAE;IACpB,OAAO,QAAQ,YAAY,IAAI,CAAA;AACnC,CAAC,CAAA;AAED,kFAAkF;AAClF,MAAM,UAAU,iBAAiB,CAAC,GAAW;IACzC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACzB,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACpC,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC3E,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAI,GAAM,EAAE,KAAa;IACtD,MAAM,KAAK,GAAQ,EAAE,CAAA;IACrB,IAAI,OAAO,GAAa,GAAG,CAAA;IAE3B,OAAO,OAAO,EAAE,CAAC;QACb,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACb,MAAK;QACT,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;IAC5C,CAAC;IAED,OAAO,KAAK,CAAA;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "what-are-you",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Assortment of type-related checks and information.",
   "keywords": [
     "type",
@@ -87,4 +87,4 @@
   },
   "packageManager": "yarn@4.9.1",
   "sourcesRoot": "src"
-}
+}

package/src/ctor-type.ts

@@ -0,0 +1,24 @@
+type _ProtectedCtor<T extends object> = typeof _ProtectedCtorClass & {
+    prototype: T
+}
+type _PrivateCtor<T extends object> = typeof _PrivateCtorClass & {
+    prototype: T
+}
+type _PublicCtor<T extends object> = abstract new (...args: any[]) => T
+export type AnyCtor<T extends object> = _ProtectedCtor<T> | _PublicCtor<T> | _PrivateCtor<T>
+
+export type InstanceTypeOf<T extends AnyCtor<any>> =
+    T extends _PrivateCtor<infer U>
+        ? U
+        : T extends _ProtectedCtor<infer U>
+          ? U
+          : T extends _PublicCtor<infer U>
+            ? U
+            : never
+declare abstract class _ProtectedCtorClass {
+    protected constructor(...args: any[])
+}
+
+declare abstract class _PrivateCtorClass {
+    private constructor(...args: any[])
+}

package/src/get-text.ts

@@ -0,0 +1,111 @@
+import {
+    isBigInt,
+    isFunction,
+    isNullish,
+    isObject,
+    isString,
+    isSymbol,
+    isThenable
+} from "./is-basic.js"
+import { isAsyncIterable, isDoddle, isIterable, isNextable } from "./is-special.js"
+
+/**
+ * Gets a short value type name, which can be used in a message.
+ *
+ * @param value - The value to check.
+ */
+export function getNiceTypeOf(value: any) {
+    return value === null ? "null" : typeof value
+}
+/**
+ * Describes an object's class, type, or constructor name to be used in a message.
+ *
+ * - 📦 For an object, returns the name of its constructor or similar string.
+ * - ⚙️ For a function (or class), returns the function's name.
+ * - 🔠 For other values, returns the `typeof` string via {@link getNiceTypeOf}.
+ *
+ * @param something - The value whose class name or type is to be determined.
+ */
+export function getNiceClassName(something: any) {
+    if (isFunction(something)) {
+        return getFunctionName(something)
+    }
+    if (!isObject(something)) {
+        return getNiceTypeOf(something)
+    }
+
+    let name: string | undefined
+    if (something.constructor) {
+        name = getFunctionName(something.constructor)
+    }
+    const o = "Object"
+    return name && name !== o ? name : (getObjectStringTag(something) ?? o)
+}
+
+export function getObjectStringTag(object: any) {
+    return object[Symbol.toStringTag]
+}
+/**
+ * Gets the description of a symbol.
+ *
+ * @param symbol - The symbol to get the description of.
+ */
+export function getSymbolDescription(symbol: symbol) {
+    return `${symbol.description}`
+}
+
+function _getShortObjectString(object: any) {
+    if (isDoddle(object)) {
+        return object.toString()
+    }
+    if (isIterable(object)) {
+        return `iterable ${getNiceClassName(object)}`
+    } else if (isAsyncIterable(object)) {
+        return `async iterable ${getNiceClassName(object)}`
+    } else if (isNextable(object)) {
+        return `iterator ${getNiceClassName(object)}`
+    } else if (isThenable(object)) {
+        return `a Promise`
+    } else {
+        return `object ${getNiceClassName(object)}`
+    }
+}
+
+/**
+ * Gets a short string describing a value, to be used in a message.
+ *
+ * @param value - The value to describe.
+ */
+export function getNiceValueName(value: any) {
+    if (isNullish(value)) {
+        return `${value}`
+    }
+    if (isFunction(value)) {
+        return `function ${getFunctionName(value) || "<anonymous>"}`
+    }
+    if (isBigInt(value)) {
+        return `${value}n`
+    }
+    if (isSymbol(value)) {
+        return `Symbol(${getSymbolDescription(value)})`
+    }
+    if (isString(value)) {
+        if (value.length > 30) {
+            value = value.slice(0, 30) + "⋯"
+        }
+        return `"${value}"`
+    }
+    if (isObject(value)) {
+        return _getShortObjectString(value)
+    }
+    return `${value}`
+}
+
+/**
+ * Gets the name of a function, or null if it has no name.
+ *
+ * @param func - The function to get the name of.
+ */
+export function getFunctionName(func: Function) {
+    return func.name || undefined
+}

package/src/index.ts

@@ -1,300 +1,37 @@
-/**
- * Checks if the given value is an object.
- *
- * @template T - The type of the value to check.
- * @param value - The value to test.
- */
-export function isObject<T>(value: T): value is T & {} {
-    return typeof value === "object" && value != null
-}
-
-/**
- * Checks if the given value is a function.
- *
- * @param value - The value to check.
- */
-export function isFunction(value: unknown): value is Function {
-    return typeof value === "function"
-}
-
-/**
- * Checks if the given value is a BigInt.
- *
- * @param value - The value to check.
- */
-export const isBigInt = (value: any): value is bigint => {
-    return typeof value === "bigint"
-}
-
-/**
- * Checks if the given value is a string.
- *
- * @param value - The value to check.
- */
-export const isString = (value: any): value is string => {
-    return typeof value === "string"
-}
-/**
- * Checks if the given value is acceptable as the key of a property.
- *
- * That is, whether it's a string, a number, or a symbol.
- *
- * @param value - The value to check.
- */
-export const isPropertyKey = (value: any): value is PropertyKey => {
-    return isString(value) || isSymbol(value) || isNumber(value)
-}
-
-/**
- * Checks if the given value is null or undefined.
- *
- * @param value - The value to check.
- */
-export const isNullish = (value: any): value is null | undefined => {
-    return value == null
-}
-
-/**
- * Checks if the given value is an array.
- *
- * @param value - The value to check.
- */
-export const isArray = Array.isArray
-
-/**
- * Checks if the given value is a thenable (i.e., a Promise or similar).
- *
- * @template T - Allows asserting the type of the resolved value. Not part of the check.
- * @param what - The value to check.
- */
-export const isThenable = <T = unknown>(what: unknown): what is PromiseLike<T> => {
-    return isObject(what) && isFunction((what as any).then)
-}
-
-/**
- * Checks if the given value is a number.
- *
- * @param v - The value to check.
- */
-export const isNumber = (v: number) => +v === v
-/**
- * Checks if the given value is a number and can be represented exactly in JavaScript.
- *
- * That is, if it's a number in the range (-2⁵³, 2⁵³).
- *
- * @param v - The value to check.
- */
-export const isInt = Number.isSafeInteger
-/**
- * Checks if the given value is either a {@link isInt safe integer} or Infinity.
- *
- * @param v - The value to check.
- */
-export const isIntOrInfinity = (v: number) => isInt(v) || v === Infinity
-
-/**
- * Checks if the given value is a {@link isInt safe integer} and non-negative.
- *
- * @param v - The value to check.
- * @see {@link isInt}
- */
-export const isNat = (v: number) => isInt(v) && v >= 0
-/**
- * Checks if the given value is either a non-negative {@link isInt safe integer} or Infinity.
- *
- * @param v - The value to check.
- */
-export const isNatOrInfinity = (v: number) => isIntOrInfinity(v) && v >= 0
-/**
- * Checks if the given value is a boolean.
- *
- * @param value - The value to check.
- */
-export const isBool = (value: boolean) => !!value === value
-/**
- * Checks if the given value is not null or undefined.
- *
- * @param value - The value to check.
- */
-export const isNotNullish = (value: any) => !isNullish(value)
-/**
- * Checks if the given value is an array of two elements.
- *
- * @param value - The value to check.
- */
-export const isPair = (value: any) => isArray(value) && value.length === 2
-/**
- * Checks if the given value is a {@link isInt safe integer} and positive.
- *
- * @param value - The value to check.
- */
-export const isPosInt = (value: number) => isInt(value) && value > 0
-/**
- * Checks if the given value is an Error object.
- *
- * @param value - The value to check.
- */
-export const isError = (value: any) => value instanceof Error
-/**
- * Checks if the given value is a symbol.
- *
- * @param value - The value to check.
- */
-export const isSymbol = (value: any) => typeof value === "symbol"
-
-/**
- * Checks if the given value is array-like. It must be an object and have an integer `length`
- * property.
- *
- * @template T - Allows asserting the element type. Not part of the check.
- * @param value - The value to check.
- */
-export function isArrayLike<T>(value: any): value is ArrayLike<T> {
-    return isObject(value) && !isFunction(value) && isInt(value.length)
-}
-
-/**
- * Checks if the given value is an object
- *
- * @param value - The value to check.
- */
-export function isIterable<T>(value: any): value is Iterable<T> {
-    return isObject(value) && isFunction(value[Symbol.iterator])
-}
-/**
- * Checks if the given value is an iterable or async iterable.
- *
- * @template T - Allows asserting the element type. Not part of the check.
- * @param value - The value to check.
- */
-export function isAnyIterable<T = unknown>(value: any): value is Iterable<T> {
-    return isIterable(value) || isAsyncIterable(value)
-}
-
-/**
- * Checks if the given value is an async iterable.
- *
- * @template T - Allows asserting the element type. Not part of the check.
- * @param value - The value to check.
- */
-export function isAsyncIterable<T>(value: any): value is AsyncIterable<T> {
-    return isObject(value) && isFunction(value[Symbol.asyncIterator])
-}
-
-export function isNextable<T>(value: any): value is Iterator<T> | AsyncIterator<T> {
-    // Checks if value is an iterator
-    return isObject(value) && isFunction(value.next)
-}
-
-/**
- * Checks if the given value is a Doddle object.
- *
- * @param value - The value to check.
- * @returns True if the value is a Doddle object, false otherwise.
- */
-export function isDoddle<T>(value: any): value is {
-    pull(): T
-} {
-    return isObject(value) && isFunction(value.pull) && isFunction(value.map)
-}
-
-/**
- * Gets a short value type name, which can be used in a message.
- *
- * @param value - The value to check.
- */
-export function getNiceTypeOf(value: any) {
-    return value === null ? "null" : typeof value
-}
-/**
- * Describes an object's class, type, or constructor name to be used in a message.
- *
- * - 📦 For an object, returns the name of its constructor or similar string.
- * - ⚙️ For a function (or class), returns the function's name.
- * - 🔠 For other values, returns the `typeof` string via {@link getNiceTypeOf}.
- *
- * @param something - The value whose class name or type is to be determined.
- */
-export function getNiceClassName(something: any) {
-    if (isFunction(something)) {
-        return getFunctionName(something)
-    }
-    if (!isObject(something)) {
-        return getNiceTypeOf(something)
-    }
-
-    let name: string | undefined
-    if (something.constructor) {
-        name = getFunctionName(something.constructor)
-    }
-    const o = "Object"
-    return name && name !== o ? name : (getObjectStringTag(something) ?? o)
-}
-
-export function getObjectStringTag(object: any) {
-    return object[Symbol.toStringTag]
-}
-/**
- * Gets the description of a symbol.
- *
- * @param symbol - The symbol to get the description of.
- */
-export function getSymbolDescription(symbol: symbol) {
-    return `${symbol.description}`
-}
-
-function _getShortObjectString(object: any) {
-    if (isDoddle(object)) {
-        return object.toString()
-    }
-    if (isIterable(object)) {
-        return `iterable ${getNiceClassName(object)}`
-    } else if (isAsyncIterable(object)) {
-        return `async iterable ${getNiceClassName(object)}`
-    } else if (isNextable(object)) {
-        return `iterator ${getNiceClassName(object)}`
-    } else if (isThenable(object)) {
-        return `a Promise`
-    } else {
-        return `object ${getNiceClassName(object)}`
-    }
-}
-
-/**
- * Gets a short string describing a value, to be used in a message.
- *
- * @param value - The value to describe.
- */
-export function getNiceValueName(value: any) {
-    if (isNullish(value)) {
-        return `${value}`
-    }
-    if (isFunction(value)) {
-        return `function ${getFunctionName(value) || "<anonymous>"}`
-    }
-    if (isBigInt(value)) {
-        return `${value}n`
-    }
-    if (isSymbol(value)) {
-        return `Symbol(${getSymbolDescription(value)})`
-    }
-    if (isString(value)) {
-        if (value.length > 30) {
-            value = value.slice(0, 30) + "⋯"
-        }
-        return `"${value}"`
-    }
-    if (isObject(value)) {
-        return _getShortObjectString(value)
-    }
-    return `${value}`
-}
-
-/**
- * Gets the name of a function, or null if it has no name.
- *
- * @param func - The function to get the name of.
- */
-export function getFunctionName(func: Function) {
-    return func.name || undefined
-}
+export {
+    getFunctionName,
+    getNiceClassName,
+    getNiceTypeOf,
+    getNiceValueName,
+    getSymbolDescription
+} from "./get-text.js"
+export {
+    isArray,
+    isBigInt,
+    isBool,
+    isError,
+    isFunction,
+    isInt,
+    isIntOrInfinity,
+    isNat,
+    isNatOrInfinity,
+    isNotNullish,
+    isNullish,
+    isNumber,
+    isObject,
+    isPair,
+    isPosInt,
+    isPropertyKey,
+    isString,
+    isSymbol,
+    isThenable
+} from "./is-basic.js"
+export {
+    isAnyIterable,
+    isArrayLike,
+    isAsyncIterable,
+    isDoddle,
+    isIterable,
+    isNextable
+} from "./is-special.js"
+export { getPrototypeChain, isInstanceOf, isPrototypeObject } from "./prototypes.js"

package/src/is-basic.ts

@@ -0,0 +1,143 @@
+/**
+ * Checks if the given value is an object.
+ *
+ * @template T - The type of the value to check.
+ * @param value - The value to test.
+ */
+export function isObject<T>(value: T): value is T & {} {
+    return typeof value === "object" && value != null
+}
+
+/**
+ * Checks if the given value is a function.
+ *
+ * @param value - The value to check.
+ */
+export function isFunction(value: unknown): value is Function {
+    return typeof value === "function"
+}
+
+/**
+ * Checks if the given value is a BigInt.
+ *
+ * @param value - The value to check.
+ */
+export const isBigInt = (value: any): value is bigint => {
+    return typeof value === "bigint"
+}
+
+/**
+ * Checks if the given value is a string.
+ *
+ * @param value - The value to check.
+ */
+export const isString = (value: any): value is string => {
+    return typeof value === "string"
+}
+/**
+ * Checks if the given value is acceptable as the key of a property.
+ *
+ * That is, whether it's a string, a number, or a symbol.
+ *
+ * @param value - The value to check.
+ */
+export const isPropertyKey = (value: any): value is PropertyKey => {
+    return isString(value) || isSymbol(value) || isNumber(value)
+}
+
+/**
+ * Checks if the given value is null or undefined.
+ *
+ * @param value - The value to check.
+ */
+export const isNullish = (value: any): value is null | undefined => {
+    return value == null
+}
+
+/**
+ * Checks if the given value is an array.
+ *
+ * @param value - The value to check.
+ */
+export const isArray = Array.isArray
+
+/**
+ * Checks if the given value is a thenable (i.e., a Promise or similar).
+ *
+ * @template T - Allows asserting the type of the resolved value. Not part of the check.
+ * @param what - The value to check.
+ */
+export const isThenable = <T = unknown>(what: unknown): what is PromiseLike<T> => {
+    return isObject(what) && isFunction((what as any).then)
+}
+
+/**
+ * Checks if the given value is a number.
+ *
+ * @param v - The value to check.
+ */
+export const isNumber = (v: number) => +v === v
+/**
+ * Checks if the given value is a number and can be represented exactly in JavaScript.
+ *
+ * That is, if it's a number in the range (-2⁵³, 2⁵³).
+ *
+ * @param v - The value to check.
+ */
+export const isInt = Number.isSafeInteger
+/**
+ * Checks if the given value is either a {@link isInt safe integer} or Infinity.
+ *
+ * @param v - The value to check.
+ */
+export const isIntOrInfinity = (v: number) => isInt(v) || v === Infinity
+
+/**
+ * Checks if the given value is a {@link isInt safe integer} and non-negative.
+ *
+ * @param v - The value to check.
+ * @see {@link isInt}
+ */
+export const isNat = (v: number) => isInt(v) && v >= 0
+/**
+ * Checks if the given value is either a non-negative {@link isInt safe integer} or Infinity.
+ *
+ * @param v - The value to check.
+ */
+export const isNatOrInfinity = (v: number) => isIntOrInfinity(v) && v >= 0
+/**
+ * Checks if the given value is a boolean.
+ *
+ * @param value - The value to check.
+ */
+export const isBool = (value: boolean) => !!value === value
+/**
+ * Checks if the given value is not null or undefined.
+ *
+ * @param value - The value to check.
+ */
+export const isNotNullish = (value: any) => !isNullish(value)
+/**
+ * Checks if the given value is an array of two elements.
+ *
+ * @param value - The value to check.
+ */
+export const isPair = (value: any) => isArray(value) && value.length === 2
+/**
+ * Checks if the given value is a {@link isInt safe integer} and positive.
+ *
+ * @param value - The value to check.
+ */
+export const isPosInt = (value: number) => isInt(value) && value > 0
+/**
+ * Checks if the given value is an Error object.
+ *
+ * @param value - The value to check.
+ */
+export const isError = (value: any) => value instanceof Error
+/**
+ * Checks if the given value is a symbol.
+ *
+ * @param value - The value to check.
+ */
+export const isSymbol = (value: any) => typeof value === "symbol"