@pezkuwi/util 14.0.6 → 14.0.7

package/build/is/bn.d.ts

@@ -1,17 +0,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 declare function isBn(value: unknown): value is BN;

package/build/is/bn.js

@@ -1,19 +0,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) {
-    return BN.isBN(value);
-}

package/build/is/boolean.d.ts

@@ -1,15 +0,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 declare function isBoolean(value: unknown): value is boolean;

package/build/is/boolean.js

@@ -1,17 +0,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) {
-    return typeof value === 'boolean';
-}

package/build/is/buffer.d.ts

@@ -1,16 +0,0 @@
-import type { BufferObject } from '../types.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 declare function isBuffer<T = BufferObject>(value: unknown): value is T;

package/build/is/buffer.js

@@ -1,21 +0,0 @@
-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(value) {
-    // we do check a function first, since it is slightly faster than isBuffer itself
-    return hasBuffer && !!value && isFunction(value.readDoubleLE) && xglobal.Buffer.isBuffer(value);
-}

package/build/is/childClass.d.ts

@@ -1,17 +0,0 @@
-import type { Class } from '../types.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 declare function isChildClass<P extends Class>(Parent: P, Child?: unknown): Child is P;

package/build/is/childClass.js

@@ -1,23 +0,0 @@
-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(Parent, Child) {
-    // 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/build/is/class.d.ts

@@ -1,6 +0,0 @@
-import type { Class } from '../types.js';
-/**
- * @name isClass
- * Tests if the supplied argument is a Class
- */
-export declare const isClass: <T extends Class>(value?: unknown) => value is T;

package/build/is/class.js

@@ -1,6 +0,0 @@
-import { isOnFunction } from './helpers.js';
-/**
- * @name isClass
- * Tests if the supplied argument is a Class
- */
-export const isClass = /*#__PURE__*/ isOnFunction('isPrototypeOf', 'hasOwnProperty');

package/build/is/codec.d.ts

@@ -1,12 +0,0 @@
-import type { HexString } from '../types.js';
-interface Registry {
-    get: (...params: never[]) => any;
-}
-interface Codec {
-    readonly registry: Registry;
-    toHex(...params: never[]): HexString;
-    toHuman(...params: never[]): unknown;
-    toU8a: (...params: never[]) => Uint8Array;
-}
-export declare function isCodec<T extends Codec = Codec>(value?: unknown): value is T;
-export {};

package/build/is/codec.js

@@ -1,6 +0,0 @@
-import { isOnObject } from './helpers.js';
-const checkCodec = /*#__PURE__*/ isOnObject('toHex', 'toHuman', 'toU8a');
-const checkRegistry = /*#__PURE__*/ isOnObject('get');
-export function isCodec(value) {
-    return checkCodec(value) && checkRegistry(value.registry);
-}

package/build/is/compact.d.ts

@@ -1,13 +0,0 @@
-import type { BN } from '../bn/bn.js';
-interface Compact<T> {
-    toBigInt(): bigint;
-    toBn(): BN;
-    toNumber(): number;
-    unwrap(): T;
-}
-/**
- * @name isCompact
- * @summary Tests for SCALE-Compact-like object instance.
- */
-export declare const isCompact: <T>(value?: unknown) => value is Compact<T>;
-export {};

package/build/is/compact.js

@@ -1,6 +0,0 @@
-import { isOnObject } from './helpers.js';
-/**
- * @name isCompact
- * @summary Tests for SCALE-Compact-like object instance.
- */
-export const isCompact = /*#__PURE__*/ isOnObject('toBigInt', 'toBn', 'toNumber', 'unwrap');

package/build/is/error.d.ts

@@ -1,15 +0,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 declare function isError(value: unknown): value is Error;

package/build/is/error.js

@@ -1,18 +0,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) {
-    return (((value && value.constructor) === Error) ||
-        value instanceof Error);
-}

package/build/is/function.d.ts

@@ -1,17 +0,0 @@
-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 declare function isFunction(value: unknown): value is FnType;
-export {};

package/build/is/function.js

@@ -1,17 +0,0 @@
-/**
- * @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) {
-    return typeof value === 'function';
-}

package/build/is/helpers.d.ts

@@ -1,3 +0,0 @@
-export declare function isOn<T>(...fns: (keyof T)[]): (value?: unknown) => value is T;
-export declare function isOnFunction<T>(...fns: (keyof T)[]): (value?: unknown) => value is T;
-export declare function isOnObject<T>(...fns: (keyof T)[]): (value?: unknown) => value is T;

package/build/is/helpers.js

@@ -1,14 +0,0 @@
-import { isFunction } from './function.js';
-import { isObject } from './object.js';
-export function isOn(...fns) {
-    return (value) => (isObject(value) || isFunction(value)) &&
-        fns.every((f) => isFunction(value[f]));
-}
-export function isOnFunction(...fns) {
-    return (value) => isFunction(value) &&
-        fns.every((f) => isFunction(value[f]));
-}
-export function isOnObject(...fns) {
-    return (value) => isObject(value) &&
-        fns.every((f) => isFunction(value[f]));
-}

package/build/is/hex.d.ts

@@ -1,19 +0,0 @@
-import type { HexString } from '../types.js';
-export declare const REGEX_HEX_PREFIXED: RegExp;
-export declare const REGEX_HEX_NOPREFIX: RegExp;
-/**
- * @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 declare function isHex(value: unknown, bitLength?: number, ignoreLength?: boolean): value is HexString;

package/build/is/hex.js

@@ -1,23 +0,0 @@
-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, bitLength = -1, ignoreLength) {
-    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/build/is/index.d.ts

@@ -1,33 +0,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/build/is/index.js

@@ -1,33 +0,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/build/is/instanceOf.d.ts

@@ -1,15 +0,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
- * ```
- */
-export declare function isInstanceOf(value: unknown, Clazz: Function): boolean;

package/build/is/instanceOf.js

@@ -1,18 +0,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
- * ```
- */
-export function isInstanceOf(value, Clazz) {
-    return (((value && value.constructor) === Clazz) ||
-        value instanceof Clazz);
-}

package/build/is/ip.d.ts

@@ -1,18 +0,0 @@
-/**
- * @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 declare function isIp(value: string, type?: 'v4' | 'v6'): boolean;

package/build/is/ip.js

@@ -1,41 +0,0 @@
-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, type) {
-    switch (type) {
-        case 'v4': return v4exact.test(value);
-        case 'v6': return v6exact.test(value);
-        default: return v46Exact.test(value);
-    }
-}

package/build/is/jsonObject.d.ts

@@ -1,27 +0,0 @@
-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 declare function isJsonObject(value: unknown): value is ObjectIndexed;
-export {};

package/build/is/jsonObject.js

@@ -1,37 +0,0 @@
-import { stringify } from '../stringify.js';
-/**
- * @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) {
-    const str = typeof value !== 'string'
-        ? stringify(value)
-        : value;
-    try {
-        const obj = JSON.parse(str);
-        return typeof obj === 'object' && obj !== null;
-    }
-    catch {
-        return false;
-    }
-}

package/build/is/null.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name isNull
- * @summary Tests for a `null` values.
- * @description
- * Checks to see if the input value is `null`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isNull } from '@pezkuwi/util';
- *
- * console.log('isNull', isNull(null)); // => true
- * ```
- */
-export declare function isNull(value?: unknown): value is null;

package/build/is/null.js

@@ -1,17 +0,0 @@
-/**
- * @name isNull
- * @summary Tests for a `null` values.
- * @description
- * Checks to see if the input value is `null`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isNull } from '@pezkuwi/util';
- *
- * console.log('isNull', isNull(null)); // => true
- * ```
- */
-export function isNull(value) {
-    return value === null;
-}

package/build/is/number.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name isNumber
- * @summary Tests for a JavaScript number.
- * @description
- * Checks to see if the input value is a valid number.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isNumber } from '@pezkuwi/util';
- *
- * console.log('isNumber', isNumber(1234)); // => true
- * ```
- */
-export declare function isNumber(value: unknown): value is number;

package/build/is/number.js

@@ -1,17 +0,0 @@
-/**
- * @name isNumber
- * @summary Tests for a JavaScript number.
- * @description
- * Checks to see if the input value is a valid number.
- * @example
- * <BR>
- *
- * ```javascript
- * import { isNumber } from '@pezkuwi/util';
- *
- * console.log('isNumber', isNumber(1234)); // => true
- * ```
- */
-export function isNumber(value) {
-    return typeof value === 'number';
-}