@pezkuwi/util 14.0.1

package/src/is/codec.spec.ts

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

@@ -0,0 +1,26 @@
+// Copyright 2017-2025 @polkadot/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

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

@@ -0,0 +1,19 @@
+// 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

@@ -0,0 +1,20 @@
+// 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/error.ts

@@ -0,0 +1,23 @@
+// Copyright 2017-2025 @polkadot/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

@@ -0,0 +1,20 @@
+// 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

@@ -0,0 +1,23 @@
+// 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

@@ -0,0 +1,23 @@
+// 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

@@ -0,0 +1,77 @@
+// 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

@@ -0,0 +1,36 @@
+// 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/index.ts

@@ -0,0 +1,36 @@
+// Copyright 2017-2025 @polkadot/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';

package/src/is/instanceOf.spec.ts

@@ -0,0 +1,48 @@
+// 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

@@ -0,0 +1,24 @@
+// 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

@@ -0,0 +1,50 @@
+// 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/ip.ts

@@ -0,0 +1,56 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// The regex patterns below were copied as-is from the ip-regex package 5.0.0,
+// https://github.com/sindresorhus/ip-regex/blob/a2a44dfa7f776528158c2a5ff9d8a1be435ec1b9/index.js#L1
+//
+// MIT License
+// Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+//
+// Changes made:
+//  - boundary support option has been dropped
+//  - only exact matching is used (isIp always passed exact: true)
+//  - the newest ip-regex is ESM-only, we compile to all platforms
+const v4 = '(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}';
+const v6s = '[a-fA-F\\d]{1,4}';
+const v6 = `
+(?:
+(?:${v6s}:){7}(?:${v6s}|:)|                                    // 1:2:3:4:5:6:7::  1:2:3:4:5:6:7:8
+(?:${v6s}:){6}(?:${v4}|:${v6s}|:)|                             // 1:2:3:4:5:6::    1:2:3:4:5:6::8   1:2:3:4:5:6::8  1:2:3:4:5:6::1.2.3.4
+(?:${v6s}:){5}(?::${v4}|(?::${v6s}){1,2}|:)|                   // 1:2:3:4:5::      1:2:3:4:5::7:8   1:2:3:4:5::8    1:2:3:4:5::7:1.2.3.4
+(?:${v6s}:){4}(?:(?::${v6s}){0,1}:${v4}|(?::${v6s}){1,3}|:)| // 1:2:3:4::        1:2:3:4::6:7:8   1:2:3:4::8      1:2:3:4::6:7:1.2.3.4
+(?:${v6s}:){3}(?:(?::${v6s}){0,2}:${v4}|(?::${v6s}){1,4}|:)| // 1:2:3::          1:2:3::5:6:7:8   1:2:3::8        1:2:3::5:6:7:1.2.3.4
+(?:${v6s}:){2}(?:(?::${v6s}){0,3}:${v4}|(?::${v6s}){1,5}|:)| // 1:2::            1:2::4:5:6:7:8   1:2::8          1:2::4:5:6:7:1.2.3.4
+(?:${v6s}:){1}(?:(?::${v6s}){0,4}:${v4}|(?::${v6s}){1,6}|:)| // 1::              1::3:4:5:6:7:8   1::8            1::3:4:5:6:7:1.2.3.4
+(?::(?:(?::${v6s}){0,5}:${v4}|(?::${v6s}){1,7}|:))             // ::2:3:4:5:6:7:8  ::2:3:4:5:6:7:8  ::8             ::1.2.3.4
+)(?:%[0-9a-zA-Z]{1,})?                                             // %eth0            %1
+`.replace(/\s*\/\/.*$/gm, '').replace(/\n/g, '').trim();
+
+const v46Exact = new RegExp(`(?:^${v4}$)|(?:^${v6}$)`);
+const v4exact = new RegExp(`^${v4}$`);
+const v6exact = new RegExp(`^${v6}$`);
+
+/**
+ * @name isIp
+ * @summary Tests if the value is a valid IP address
+ * @description
+ * Checks to see if the value is a valid IP address. Optionally check for either v4/v6
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isIp } from '@pezkuwi/util';
+ *
+ * isIp('192.168.0.1')); // => true
+ * isIp('1:2:3:4:5:6:7:8'); // => true
+ * isIp('192.168.0.1', 'v6')); // => false
+ * isIp('1:2:3:4:5:6:7:8', 'v4'); // => false
+ * ```
+ */
+export function isIp (value: string, type?: 'v4' | 'v6'): boolean {
+  switch (type) {
+    case 'v4': return v4exact.test(value);
+    case 'v6': return v6exact.test(value);
+    default: return v46Exact.test(value);
+  }
+}

package/src/is/jsonObject.spec.ts

@@ -0,0 +1,51 @@
+// 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/jsonObject.ts

@@ -0,0 +1,45 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { stringify } from '../stringify.js';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ObjectIndexed = Record<string, any>;
+
+/**
+ * @name isJsonObject
+ * @summary Tests for a valid JSON `object`.
+ * @description
+ * Checks to see if the input value is a valid JSON object.
+ * It returns false if the input is JSON parsable, but not an Javascript object.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isJsonObject } from '@pezkuwi/util';
+ *
+ * isJsonObject({}); // => true
+ * isJsonObject({
+ *  "Test": "1234",
+ *  "NestedTest": {
+ *   "Test": "5678"
+ *  }
+ * }); // => true
+ * isJsonObject(1234); // JSON parsable, but not an object =>  false
+ * isJsonObject(null); // JSON parsable, but not an object => false
+ * isJsonObject('not an object'); // => false
+ * ```
+ */
+export function isJsonObject (value: unknown): value is ObjectIndexed {
+  const str = typeof value !== 'string'
+    ? stringify(value)
+    : value;
+
+  try {
+    const obj = JSON.parse(str) as unknown;
+
+    return typeof obj === 'object' && obj !== null;
+  } catch {
+    return false;
+  }
+}