@pezkuwi/util 14.0.1 → 14.0.3

package/src/is/compact.ts

@@ -1,19 +0,0 @@
-// Copyright 2017-2025 @polkadot/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 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/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/function.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/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 @polkadot/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 @polkadot/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 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/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 @polkadot/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/instanceOf.spec.ts

@@ -1,48 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isInstanceOf } from './index.js';
-
-describe('isInstanceOf', (): void => {
-  it('returns true on real instances', (): void => {
-    expect(
-      isInstanceOf(new Array(2), Array)
-    ).toEqual(true);
-  });
-
-  it('returns true on real instances (inherited)', (): void => {
-    class Test extends Array {
-      // default
-    }
-
-    expect(
-      isInstanceOf(new Test(2), Array)
-    ).toEqual(true);
-  });
-
-  it('returns false on non-allocated instances', (): void => {
-    expect(
-      isInstanceOf([], Array)
-    ).toEqual(true);
-  });
-
-  it('returns false on non-instances', (): void => {
-    expect(
-      isInstanceOf('array', Array)
-    ).toEqual(false);
-  });
-
-  it('returns false when class not specified', (): void => {
-    expect(
-      isInstanceOf('array', Array)
-    ).toEqual(false);
-  });
-
-  it('returns false on wrong class type', (): void => {
-    expect(
-      isInstanceOf(new Array(2), String)
-    ).toEqual(false);
-  });
-});

package/src/is/instanceOf.ts

@@ -1,24 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name isInstanceOf
- * @summary Tests for a instance of a class.
- * @description
- * Checks to see if the input value is an instance of the test class.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isInstanceOf } from '@pezkuwi/util';
- *
- * console.log('isInstanceOf', isInstanceOf(new Array(0), Array)); // => true
- * ```
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function isInstanceOf (value: unknown, Clazz: Function): boolean {
-  return (
-    ((value && (value as Record<string, unknown>).constructor) === Clazz) ||
-    value instanceof Clazz
-  );
-}

package/src/is/ip.spec.ts

@@ -1,50 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isIp } from './index.js';
-
-describe('isIp', (): void => {
-  it('returns false when non-ip found', (): void => {
-    expect(
-      isIp('not.an.ip.1')
-    ).toEqual(false);
-  });
-
-  it('returns true on IPv4 addresses', (): void => {
-    expect(
-      isIp('192.168.0.1')
-    ).toEqual(true);
-  });
-
-  it('returns true on IPv4 addresses (IPV4 type)', (): void => {
-    expect(
-      isIp('192.168.0.1', 'v4')
-    ).toEqual(true);
-  });
-
-  it('returns false on IPv4 addresses (IPv6 type)', (): void => {
-    expect(
-      isIp('192.168.0.1', 'v6')
-    ).toEqual(false);
-  });
-
-  it('returns true on IPv6 addresses', (): void => {
-    expect(
-      isIp('1:2:3:4:5:6:7:8')
-    ).toEqual(true);
-  });
-
-  it('returns true on IPv6 addresses (IPv6 type)', (): void => {
-    expect(
-      isIp('1:2:3:4:5:6:7:8', 'v6')
-    ).toEqual(true);
-  });
-
-  it('returns false on IPv6 addresses (IPv4 type)', (): void => {
-    expect(
-      isIp('1:2:3:4:5:6:7:8', 'v4')
-    ).toEqual(false);
-  });
-});

package/src/is/jsonObject.spec.ts

@@ -1,51 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isJsonObject } from './index.js';
-
-const jsonObject = `{
-    "Test": "1234",
-    "NestedTest": {
-      "Test": "5678"
-    }
-  }`;
-
-describe('isJsonObject', (): void => {
-  it('returns true on empty objects', (): void => {
-    expect(
-      isJsonObject({})
-    ).toEqual(true);
-  });
-
-  it('returns true on JSON objects', (): void => {
-    expect(
-      isJsonObject(jsonObject)
-    ).toEqual(true);
-  });
-
-  it('returns false on JSON parsable value typeof number', (): void => {
-    expect(
-      isJsonObject(1234)
-    ).toEqual(false);
-  });
-
-  it('returns false on JSON parsable value null', (): void => {
-    expect(
-      isJsonObject(null)
-    ).toEqual(false);
-  });
-
-  it('returns false on invalid objects', (): void => {
-    expect(
-      isJsonObject('notAnObject')
-    ).toEqual(false);
-  });
-
-  it('returns false on invalid JSON', (): void => {
-    expect(
-      isJsonObject('{"abc", "def"}')
-    ).toEqual(false);
-  });
-});

package/src/is/null.spec.ts

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

package/src/is/number.spec.ts

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

package/src/is/object.spec.ts

@@ -1,32 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isObject } from './index.js';
-
-describe('isObject', (): void => {
-  it('returns true on valid objects', (): void => {
-    expect(
-      isObject({})
-    ).toEqual(true);
-  });
-
-  it('returns false on invalid objects', (): void => {
-    expect(
-      isObject('notAnObject')
-    ).toEqual(false);
-  });
-
-  it('returns false on null', (): void => {
-    expect(
-      isObject(null)
-    ).toEqual(false);
-  });
-
-  it('returns false on bigint', (): void => {
-    expect(
-      isObject(123n)
-    ).toEqual(false);
-  });
-});

package/src/is/object.ts

@@ -1,24 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ObjectIndexed = Record<string, any>;
-
-/**
- * @name isObject
- * @summary Tests for an `object`.
- * @description
- * Checks to see if the input value is a JavaScript object.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isObject } from '@pezkuwi/util';
- *
- * isObject({}); // => true
- * isObject('something'); // => false
- * ```
- */
-export function isObject <T extends ObjectIndexed = ObjectIndexed> (value?: unknown): value is T {
-  return !!value && typeof value === 'object';
-}

package/src/is/observable.spec.ts

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

package/src/is/promise.spec.ts

@@ -1,32 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isPromise } from './index.js';
-
-describe('isPromise', (): void => {
-  it('returns true on valid Promise (Promise-like)', (): void => {
-    expect(
-      isPromise(Promise.resolve(1))
-    ).toEqual(true);
-    expect(
-      isPromise({ catch: () => null, then: () => null })
-    ).toEqual(true);
-  });
-
-  it('returns false on invalid objects', (): void => {
-    expect(
-      isPromise('notAnObservable')
-    ).toEqual(false);
-  });
-
-  it('returns false on invalid catch/then functions', (): void => {
-    expect(
-      isPromise({ catch: () => null, then: true })
-    ).toEqual(false);
-    expect(
-      isPromise({ catch: true, then: () => null })
-    ).toEqual(false);
-  });
-});

package/src/is/promise.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { isOnObject } from './helpers.js';
-
-export const isPromise = /*#__PURE__*/ isOnObject<Promise<unknown>>('catch', 'then');

package/src/is/riscv.spec.ts

@@ -1,36 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isRiscV } from './index.js';
-
-describe('isRiscV', (): void => {
-  it('is false on non-elf/non-pvm header', (): void => {
-    expect(isRiscV(new Uint8Array([0, 97, 115, 109, 1, 2, 3]))).toEqual(false);
-  });
-
-  it('is false on partial-elf/pvm header', (): void => {
-    expect(isRiscV(new Uint8Array([0x7f, 0x45, 0x4c]))).toEqual(false);
-  });
-
-  it('is false on empty byte before elf/pvm header', (): void => {
-    expect(
-      isRiscV(
-        new Uint8Array([0x00, 0x7f, 0x45, 0x4c, 0x46, 0xff, 0x00, 0x42, 0x23])
-      )
-    ).toEqual(false);
-  });
-
-  it('is true when a elf header is found', (): void => {
-    expect(
-      isRiscV(new Uint8Array([0x7f, 0x45, 0x4c, 0x46, 0xff, 0x00, 0x42, 0x23]))
-    ).toEqual(true);
-  });
-
-  it('is true when a pvm header is found', (): void => {
-    expect(
-      isRiscV(new Uint8Array([0x50, 0x56, 0x4d, 0x00, 0xff, 0x00, 0x42, 0x23]))
-    ).toEqual(true);
-  });
-});

package/src/is/string.spec.ts

@@ -1,32 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isString } from './index.js';
-
-describe('isString', (): void => {
-  it('returns true on valid strings', (): void => {
-    expect(
-      isString('123')
-    ).toEqual(true);
-  });
-
-  it('returns true on empty strings', (): void => {
-    expect(
-      isString('')
-    ).toEqual(true);
-  });
-
-  it('returns true on String object', (): void => {
-    expect(
-      isString(String('foo'))
-    ).toEqual(true);
-  });
-
-  it('returns false on invalid numbers', (): void => {
-    expect(
-      isString(2)
-    ).toEqual(false);
-  });
-});

package/src/is/testChain.spec.ts

@@ -1,25 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@polkadot/dev-test/globals.d.ts" />
-
-import { isTestChain } from './index.js';
-
-describe('isTestChain', (): void => {
-  it('enables test environment when chain specification matches text of dev or loc(al)', (): void => {
-    const validTestModeChainSpecsWithDev = ['Development'];
-    const validTestModeChainSpecsWithLoc = ['Local Testnet'];
-
-    validTestModeChainSpecsWithDev.concat(validTestModeChainSpecsWithLoc).forEach((s): void => {
-      expect(isTestChain(s)).toEqual(true);
-    });
-  });
-
-  it('disables keyring test mode when chain specification is not a test mode or undefined or number type', (): void => {
-    const invalidTestModeChainSpecs = ['dev', 'local', 'development', 'PoC-1 Testnet', 'Staging Testnet', 'future PoC-2 Testnet', 'a pocadot?', undefined];
-
-    invalidTestModeChainSpecs.forEach((s): void => {
-      expect(isTestChain(s)).toEqual(false);
-    });
-  });
-});

package/src/is/testChain.ts

@@ -1,12 +0,0 @@
-// Copyright 2017-2025 @polkadot/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-const REGEX_DEV = /(Development|Local Testnet)$/;
-
-export function isTestChain (chain?: string | null): boolean {
-  if (!chain) {
-    return false;
-  }
-
-  return !!REGEX_DEV.test(chain.toString());
-}