@pezkuwi/util 14.0.12 → 14.0.14

package/src/is/bn.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { BN } from '../bn/bn.js';
-
-/**
- * @name isBn
- * @summary Tests for a `BN` object instance.
- * @description
- * Checks to see if the input object is an instance of `BN` (bn.js).
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { isBn } from '@pezkuwi/util';
- *
- * console.log('isBn', isBn(new BN(1))); // => true
- * ```
- */
-export function isBn (value: unknown): value is BN {
-  return BN.isBN(value);
-}

package/src/is/boolean.spec.ts

@@ -1,26 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isBoolean } from './index.js';
-
-describe('isBoolean', (): void => {
-  it('returns true on false', (): void => {
-    expect(
-      isBoolean(false)
-    ).toEqual(true);
-  });
-
-  it('returns true on true', (): void => {
-    expect(
-      isBoolean(true)
-    ).toEqual(true);
-  });
-
-  it('returns false on invalid booleans', (): void => {
-    expect(
-      isBoolean('notABool')
-    ).toEqual(false);
-  });
-});

package/src/is/boolean.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name isBoolean
- * @summary Tests for a boolean value.
- * @description
- * Checks to see if the input value is a JavaScript boolean.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isBoolean } from '@pezkuwi/util';
- *
- * isBoolean(false); // => true
- * ```
- */
-export function isBoolean (value: unknown): value is boolean {
-  return typeof value === 'boolean';
-}

package/src/is/buffer.spec.ts

@@ -1,26 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isBuffer } from './index.js';
-
-describe('isBuffer', (): void => {
-  it('returns true when a Buffer value', (): void => {
-    expect(
-      isBuffer(Buffer.from([]))
-    ).toEqual(true);
-  });
-
-  it('returns false on non-Buffer values (number)', (): void => {
-    expect(
-      isBuffer(123)
-    ).toEqual(false);
-  });
-
-  it('returns false on non-Buffer values (null)', (): void => {
-    expect(
-      isBuffer(null)
-    ).toEqual(false);
-  });
-});

package/src/is/buffer.ts

@@ -1,28 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BufferClass, BufferObject } from '../types.js';
-
-import { xglobal } from '@pezkuwi/x-global';
-
-import { hasBuffer } from '../has.js';
-import { isFunction } from './function.js';
-
-/**
- * @name isBuffer
- * @summary Tests for a `Buffer` object instance.
- * @description
- * Checks to see if the input object is an instance of `Buffer`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isBuffer } from '@pezkuwi/util';
- *
- * console.log('isBuffer', isBuffer(Buffer.from([]))); // => true
- * ```
- */
-export function isBuffer <T = BufferObject> (value: unknown): value is T {
-  // we do check a function first, since it is slightly faster than isBuffer itself
-  return hasBuffer && !!value && isFunction((value as unknown as BufferObject).readDoubleLE) && (xglobal.Buffer as unknown as BufferClass).isBuffer(value);
-}

package/src/is/childClass.spec.ts

@@ -1,36 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { BN } from '../bn/index.js';
-import { isChildClass } from './index.js';
-
-describe('isChildClass', (): void => {
-  it('returns true when a Child value', (): void => {
-    expect(
-      isChildClass(BN, class Test extends BN {})
-    ).toEqual(true);
-  });
-
-  it('returns false on non-Child values', (): void => {
-    expect(
-      isChildClass(BN, Uint8Array)
-    ).toEqual(false);
-  });
-
-  it('returns false on undefined', (): void => {
-    expect(
-      isChildClass(BN)
-    ).toEqual(false);
-  });
-
-  it('does TS magic, determining type', (): void => {
-    const T = (class extends BN {}) as unknown;
-
-    expect(
-      isChildClass(BN, T) &&
-      new T(12345).toNumber()
-    ).toEqual(12345);
-  });
-});

package/src/is/childClass.ts

@@ -1,29 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Class } from '../types.js';
-
-import { isClass } from './class.js';
-
-/**
- * @name isChildClass
- * @summary Tests if the child extends the parent Class
- * @description
- * Checks to see if the child Class extends the parent Class
- * @example
- * <BR>
- *
- * ```javascript
- * import { isChildClass } from '@pezkuwi/util';
- *
- * console.log('isChildClass', isChildClass(BN, BN); // => true
- * console.log('isChildClass', isChildClass(BN, Uint8Array); // => false
- * ```
- */
-export function isChildClass <P extends Class> (Parent: P, Child?: unknown): Child is P {
-  // https://stackoverflow.com/questions/30993434/check-if-a-constructor-inherits-another-in-es6/30993664
-  return isClass(Child) && isClass(Parent)
-    // eslint-disable-next-line no-prototype-builtins
-    ? Parent === Child || Parent.isPrototypeOf(Child)
-    : false;
-}

package/src/is/class.spec.ts

@@ -1,37 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { BN } from '../bn/index.js';
-import { isClass } from './index.js';
-
-describe('isClass', (): void => {
-  it('returns false on a pure object', (): void => {
-    expect(isClass({})).toEqual(false);
-  });
-
-  it('returns false on instance values', (): void => {
-    expect(
-      isClass(new BN(1))
-    ).toEqual(false);
-  });
-
-  it('returns true when a class value', (): void => {
-    expect(
-      isClass(BN)
-    ).toEqual(true);
-  });
-
-  it('returns true on extends', (): void => {
-    expect(
-      isClass(class Test extends BN {})
-    ).toEqual(true);
-  });
-
-  it('returns true on built-ins', (): void => {
-    expect(
-      isClass(Uint8Array)
-    ).toEqual(true);
-  });
-});

package/src/is/class.ts

@@ -1,12 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Class } from '../types.js';
-
-import { isOnFunction } from './helpers.js';
-
-/**
- * @name isClass
- * Tests if the supplied argument is a Class
- */
-export const isClass: <T extends Class> (value?: unknown) => value is T = /*#__PURE__*/ isOnFunction('isPrototypeOf', 'hasOwnProperty');

package/src/is/codec.spec.ts

@@ -1,52 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { perfCmp } from '../test/index.js';
-import { isCodec } from './index.js';
-
-const VALID = {
-  registry: {
-    get: () => null
-  },
-  toHex: () => '0x',
-  toHuman: () => '0x',
-  toU8a: () => new Uint8Array()
-};
-
-describe('isCodec', (): void => {
-  it('is false on no value', (): void => {
-    expect(isCodec()).toEqual(false);
-  });
-
-  it('is true when codec-like signature is found', (): void => {
-    expect(
-      isCodec(VALID)
-    ).toEqual(true);
-  });
-
-  it('is true when invalid codec-like signature is found', (): void => {
-    expect(
-      isCodec({
-        toHex: () => '0x',
-        toU8a: () => new Uint8Array()
-      })
-    ).toEqual(false);
-    expect(
-      isCodec({
-        registry: {
-          get: () => null
-        },
-        toHex: 1,
-        toU8a: () => new Uint8Array()
-      })
-    ).toEqual(false);
-  });
-
-  perfCmp('isCodec', ['isCodec', 'instanceof'], 500_000, [[VALID]], (v: unknown, isSecond) =>
-    isSecond
-      ? !(v instanceof String)
-      : isCodec(v)
-  );
-});

package/src/is/codec.ts

@@ -1,26 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { HexString } from '../types.js';
-
-import { isOnObject } from './helpers.js';
-
-interface Registry {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  get: (...params: never[]) => any;
-}
-
-interface Codec {
-  readonly registry: Registry;
-
-  toHex (...params: never[]): HexString;
-  toHuman (...params: never[]): unknown;
-  toU8a: (...params: never[]) => Uint8Array;
-}
-
-const checkCodec = /*#__PURE__*/ isOnObject<Codec>('toHex', 'toHuman', 'toU8a');
-const checkRegistry = /*#__PURE__*/ isOnObject<Registry>('get');
-
-export function isCodec <T extends Codec = Codec> (value?: unknown): value is T {
-  return checkCodec(value) && checkRegistry(value.registry);
-}

package/src/is/compact.spec.ts

@@ -1,27 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import BN from 'bn.js';
-
-import { isCompact } from './index.js';
-
-describe('isCompact', (): void => {
-  it('is false on no value', (): void => {
-    expect(isCompact()).toEqual(false);
-  });
-
-  it('is false on non-compact value', (): void => {
-    expect(isCompact(123)).toEqual(false);
-  });
-
-  it('is true when compact-like signature is found', (): void => {
-    expect(isCompact({
-      toBigInt: () => BigInt(1),
-      toBn: () => new BN(1),
-      toNumber: () => 1,
-      unwrap: () => new BN(1)
-    })).toEqual(true);
-  });
-});

package/src/is/compact.ts

@@ -1,19 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '../bn/bn.js';
-
-import { isOnObject } from './helpers.js';
-
-interface Compact<T> {
-  toBigInt (): bigint;
-  toBn (): BN;
-  toNumber (): number;
-  unwrap (): T;
-}
-
-/**
- * @name isCompact
- * @summary Tests for SCALE-Compact-like object instance.
- */
-export const isCompact: <T> (value?: unknown) => value is Compact<T> = /*#__PURE__*/ isOnObject('toBigInt', 'toBn', 'toNumber', 'unwrap');

package/src/is/error.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isError } from './index.js';
-
-describe('isError', (): void => {
-  it('returns true when an Error value', (): void => {
-    expect(
-      isError(new Error('testing'))
-    ).toEqual(true);
-  });
-
-  it('returns false on non-Error values', (): void => {
-    expect(
-      isError(0)
-    ).toEqual(false);
-  });
-});

package/src/is/error.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name isError
- * @summary Tests for a `Error` object instance.
- * @description
- * Checks to see if the input object is an instance of `Error`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isError } from '@pezkuwi/util';
- *
- * console.log('isError', isError(new Error('message'))); // => true
- * ```
- */
-export function isError (value: unknown): value is Error {
-  return (
-    ((value && (value as Error).constructor) === Error) ||
-    value instanceof Error
-  );
-}

package/src/is/function.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isFunction } from './index.js';
-
-describe('isFunction', (): void => {
-  it('returns true on valid functions', (): void => {
-    expect(
-      isFunction(isFunction)
-    ).toEqual(true);
-  });
-
-  it('returns false on invalid functions', (): void => {
-    expect(
-      isFunction('notAFunction')
-    ).toEqual(false);
-  });
-});

package/src/is/function.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-type FnType = Function;
-
-/**
- * @name isFunction
- * @summary Tests for a `function`.
- * @description
- * Checks to see if the input value is a JavaScript function.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isFunction } from '@pezkuwi/util';
- *
- * isFunction(() => false); // => true
- * ```
- */
-export function isFunction (value: unknown): value is FnType {
-  return typeof value === 'function';
-}

package/src/is/helpers.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { isFunction } from './function.js';
-import { isObject } from './object.js';
-
-export function isOn <T> (...fns: (keyof T)[]): (value?: unknown) => value is T {
-  return (value?: unknown): value is T =>
-    (isObject(value) || isFunction(value)) &&
-    fns.every((f) => isFunction((value as T)[f]));
-}
-
-export function isOnFunction <T> (...fns: (keyof T)[]): (value?: unknown) => value is T {
-  return (value?: unknown): value is T =>
-    isFunction(value) &&
-    fns.every((f) => isFunction((value as T)[f]));
-}
-
-export function isOnObject <T> (...fns: (keyof T)[]): (value?: unknown) => value is T {
-  return (value?: unknown): value is T =>
-    isObject(value) &&
-    fns.every((f) => isFunction((value as T)[f]));
-}

package/src/is/hex.spec.ts

@@ -1,77 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { perf } from '../test/index.js';
-import { isHex } from './index.js';
-
-describe('isHex', (): void => {
-  const test = '1234abcd';
-  const ptest = `0x${'1234567890abcdef'.repeat(8192)}`;
-
-  it('returns true on 0x hex values', (): void => {
-    expect(
-      isHex('0x')
-    ).toEqual(true);
-  });
-
-  it('returns true on hex values', (): void => {
-    expect(
-      isHex(`0x${test}`)
-    ).toEqual(true);
-  });
-
-  it('returns true on hex values with String', (): void => {
-    expect(
-      isHex(String(`0x${test}`))
-    ).toEqual(true);
-  });
-
-  it('returns false on hex values (non % 2)', (): void => {
-    expect(
-      isHex(`0x${test}0`)
-    ).toEqual(false);
-  });
-
-  it('returns true on uppercase values', (): void => {
-    expect(
-      isHex(`0x${test.toUpperCase()}`)
-    ).toEqual(true);
-  });
-
-  it('return false on hex values unprefixed', (): void => {
-    expect(
-      isHex(test)
-    ).toEqual(false);
-  });
-
-  it('returns false on non-string values', (): void => {
-    expect(
-      isHex(false)
-    ).toEqual(false);
-  });
-
-  it('returns true when valid hex and bitLength matches', (): void => {
-    expect(
-      isHex('0x1234', 16)
-    ).toEqual(true);
-  });
-
-  it('returns true when valid hex and bitLength does not match', (): void => {
-    expect(
-      isHex('0x1234', 8)
-    ).toEqual(false);
-  });
-
-  it('does ignore lengths as required', (): void => {
-    expect(
-      isHex('0x123')
-    ).toEqual(false);
-    expect(
-      isHex('0x123', -1, true)
-    ).toEqual(true);
-  });
-
-  perf(`isHex (${(ptest.length - 2) / 2} bytes)`, 1000, [[ptest]], isHex);
-});

package/src/is/hex.ts

@@ -1,36 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { HexString } from '../types.js';
-
-export const REGEX_HEX_PREFIXED = /^0x[\da-fA-F]+$/;
-
-export const REGEX_HEX_NOPREFIX = /^[\da-fA-F]+$/;
-
-/**
- * @name isHex
- * @summary Tests for a hex string.
- * @description
- * Checks to see if the input value is a `0x` prefixed hex string. Optionally (`bitLength` !== -1) checks to see if the bitLength is correct.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isHex } from '@pezkuwi/util';
- *
- * isHex('0x1234'); // => true
- * isHex('0x1234', 8); // => false
- * ```
- */
-export function isHex (value: unknown, bitLength = -1, ignoreLength?: boolean): value is HexString {
-  return (
-    typeof value === 'string' && (
-      value === '0x' ||
-      REGEX_HEX_PREFIXED.test(value)
-    )
-  ) && (
-    bitLength === -1
-      ? (ignoreLength || (value.length % 2 === 0))
-      : (value.length === (2 + Math.ceil(bitLength / 4)))
-  );
-}

package/src/is/index.ts

@@ -1,36 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @summary Type checking utilities
- */
-export { isArray } from './array.js';
-export { isAscii } from './ascii.js';
-export { isBigInt } from './bigInt.js';
-export { isBn } from './bn.js';
-export { isBoolean } from './boolean.js';
-export { isBuffer } from './buffer.js';
-export { isChildClass } from './childClass.js';
-export { isClass } from './class.js';
-export { isCodec } from './codec.js';
-export { isCompact } from './compact.js';
-export { isError } from './error.js';
-export { isFunction } from './function.js';
-export { isHex } from './hex.js';
-export { isInstanceOf } from './instanceOf.js';
-export { isIp } from './ip.js';
-export { isJsonObject } from './jsonObject.js';
-export { isNull } from './null.js';
-export { isNumber } from './number.js';
-export { isObject } from './object.js';
-export { isObservable } from './observable.js';
-export { isPromise } from './promise.js';
-export { isRiscV } from './riscv.js';
-export { isString } from './string.js';
-export { isTestChain } from './testChain.js';
-export { isToBigInt } from './toBigInt.js';
-export { isToBn } from './toBn.js';
-export { isU8a } from './u8a.js';
-export { isUndefined } from './undefined.js';
-export { isUtf8 } from './utf8.js';
-export { isWasm } from './wasm.js';