@pezkuwi/util 14.0.4 → 14.0.6

package/build/cjs/is/index.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWasm = exports.isUtf8 = exports.isUndefined = exports.isU8a = exports.isToBn = exports.isToBigInt = exports.isTestChain = exports.isString = exports.isRiscV = exports.isPromise = exports.isObservable = exports.isObject = exports.isNumber = exports.isNull = exports.isJsonObject = exports.isIp = exports.isInstanceOf = exports.isHex = exports.isFunction = exports.isError = exports.isCompact = exports.isCodec = exports.isClass = exports.isChildClass = exports.isBuffer = exports.isBoolean = exports.isBn = exports.isBigInt = exports.isAscii = exports.isArray = void 0;
+/**
+ * @summary Type checking utilities
+ */
+var array_js_1 = require("./array.js");
+Object.defineProperty(exports, "isArray", { enumerable: true, get: function () { return array_js_1.isArray; } });
+var ascii_js_1 = require("./ascii.js");
+Object.defineProperty(exports, "isAscii", { enumerable: true, get: function () { return ascii_js_1.isAscii; } });
+var bigInt_js_1 = require("./bigInt.js");
+Object.defineProperty(exports, "isBigInt", { enumerable: true, get: function () { return bigInt_js_1.isBigInt; } });
+var bn_js_1 = require("./bn.js");
+Object.defineProperty(exports, "isBn", { enumerable: true, get: function () { return bn_js_1.isBn; } });
+var boolean_js_1 = require("./boolean.js");
+Object.defineProperty(exports, "isBoolean", { enumerable: true, get: function () { return boolean_js_1.isBoolean; } });
+var buffer_js_1 = require("./buffer.js");
+Object.defineProperty(exports, "isBuffer", { enumerable: true, get: function () { return buffer_js_1.isBuffer; } });
+var childClass_js_1 = require("./childClass.js");
+Object.defineProperty(exports, "isChildClass", { enumerable: true, get: function () { return childClass_js_1.isChildClass; } });
+var class_js_1 = require("./class.js");
+Object.defineProperty(exports, "isClass", { enumerable: true, get: function () { return class_js_1.isClass; } });
+var codec_js_1 = require("./codec.js");
+Object.defineProperty(exports, "isCodec", { enumerable: true, get: function () { return codec_js_1.isCodec; } });
+var compact_js_1 = require("./compact.js");
+Object.defineProperty(exports, "isCompact", { enumerable: true, get: function () { return compact_js_1.isCompact; } });
+var error_js_1 = require("./error.js");
+Object.defineProperty(exports, "isError", { enumerable: true, get: function () { return error_js_1.isError; } });
+var function_js_1 = require("./function.js");
+Object.defineProperty(exports, "isFunction", { enumerable: true, get: function () { return function_js_1.isFunction; } });
+var hex_js_1 = require("./hex.js");
+Object.defineProperty(exports, "isHex", { enumerable: true, get: function () { return hex_js_1.isHex; } });
+var instanceOf_js_1 = require("./instanceOf.js");
+Object.defineProperty(exports, "isInstanceOf", { enumerable: true, get: function () { return instanceOf_js_1.isInstanceOf; } });
+var ip_js_1 = require("./ip.js");
+Object.defineProperty(exports, "isIp", { enumerable: true, get: function () { return ip_js_1.isIp; } });
+var jsonObject_js_1 = require("./jsonObject.js");
+Object.defineProperty(exports, "isJsonObject", { enumerable: true, get: function () { return jsonObject_js_1.isJsonObject; } });
+var null_js_1 = require("./null.js");
+Object.defineProperty(exports, "isNull", { enumerable: true, get: function () { return null_js_1.isNull; } });
+var number_js_1 = require("./number.js");
+Object.defineProperty(exports, "isNumber", { enumerable: true, get: function () { return number_js_1.isNumber; } });
+var object_js_1 = require("./object.js");
+Object.defineProperty(exports, "isObject", { enumerable: true, get: function () { return object_js_1.isObject; } });
+var observable_js_1 = require("./observable.js");
+Object.defineProperty(exports, "isObservable", { enumerable: true, get: function () { return observable_js_1.isObservable; } });
+var promise_js_1 = require("./promise.js");
+Object.defineProperty(exports, "isPromise", { enumerable: true, get: function () { return promise_js_1.isPromise; } });
+var riscv_js_1 = require("./riscv.js");
+Object.defineProperty(exports, "isRiscV", { enumerable: true, get: function () { return riscv_js_1.isRiscV; } });
+var string_js_1 = require("./string.js");
+Object.defineProperty(exports, "isString", { enumerable: true, get: function () { return string_js_1.isString; } });
+var testChain_js_1 = require("./testChain.js");
+Object.defineProperty(exports, "isTestChain", { enumerable: true, get: function () { return testChain_js_1.isTestChain; } });
+var toBigInt_js_1 = require("./toBigInt.js");
+Object.defineProperty(exports, "isToBigInt", { enumerable: true, get: function () { return toBigInt_js_1.isToBigInt; } });
+var toBn_js_1 = require("./toBn.js");
+Object.defineProperty(exports, "isToBn", { enumerable: true, get: function () { return toBn_js_1.isToBn; } });
+var u8a_js_1 = require("./u8a.js");
+Object.defineProperty(exports, "isU8a", { enumerable: true, get: function () { return u8a_js_1.isU8a; } });
+var undefined_js_1 = require("./undefined.js");
+Object.defineProperty(exports, "isUndefined", { enumerable: true, get: function () { return undefined_js_1.isUndefined; } });
+var utf8_js_1 = require("./utf8.js");
+Object.defineProperty(exports, "isUtf8", { enumerable: true, get: function () { return utf8_js_1.isUtf8; } });
+var wasm_js_1 = require("./wasm.js");
+Object.defineProperty(exports, "isWasm", { enumerable: true, get: function () { return wasm_js_1.isWasm; } });

package/build/cjs/is/instanceOf.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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/cjs/is/instanceOf.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isInstanceOf = isInstanceOf;
+/**
+ * @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
+ * ```
+ */
+function isInstanceOf(value, Clazz) {
+    return (((value && value.constructor) === Clazz) ||
+        value instanceof Clazz);
+}

package/build/cjs/is/ip.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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/cjs/is/ip.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIp = isIp;
+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
+ * ```
+ */
+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/cjs/is/jsonObject.d.ts

@@ -0,0 +1,27 @@
+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/cjs/is/jsonObject.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isJsonObject = isJsonObject;
+const stringify_js_1 = require("../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
+ * ```
+ */
+function isJsonObject(value) {
+    const str = typeof value !== 'string'
+        ? (0, stringify_js_1.stringify)(value)
+        : value;
+    try {
+        const obj = JSON.parse(str);
+        return typeof obj === 'object' && obj !== null;
+    }
+    catch {
+        return false;
+    }
+}

package/build/cjs/is/null.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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/cjs/is/null.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNull = isNull;
+/**
+ * @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
+ * ```
+ */
+function isNull(value) {
+    return value === null;
+}

package/build/cjs/is/number.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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/cjs/is/number.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNumber = isNumber;
+/**
+ * @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
+ * ```
+ */
+function isNumber(value) {
+    return typeof value === 'number';
+}

package/build/cjs/is/object.d.ts

@@ -0,0 +1,18 @@
+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 declare function isObject<T extends ObjectIndexed = ObjectIndexed>(value?: unknown): value is T;
+export {};

package/build/cjs/is/object.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+/**
+ * @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
+ * ```
+ */
+function isObject(value) {
+    return !!value && typeof value === 'object';
+}

package/build/cjs/is/observable.d.ts

@@ -0,0 +1,16 @@
+import type { Observable } from '../types.js';
+/**
+ * @name isBObservable
+ * @summary Tests for a `Observable` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `BN` (bn.js).
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isObservable } from '@pezkuwi/util';
+ *
+ * console.log('isObservable', isObservable(...));
+ * ```
+ */
+export declare const isObservable: (value?: unknown) => value is Observable;

package/build/cjs/is/observable.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObservable = void 0;
+const helpers_js_1 = require("./helpers.js");
+/**
+ * @name isBObservable
+ * @summary Tests for a `Observable` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `BN` (bn.js).
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isObservable } from '@pezkuwi/util';
+ *
+ * console.log('isObservable', isObservable(...));
+ * ```
+ */
+exports.isObservable = (0, helpers_js_1.isOn)('next');

package/build/cjs/is/promise.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPromise = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isPromise = (0, helpers_js_1.isOnObject)('catch', 'then');

package/build/cjs/is/riscv.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRiscV = isRiscV;
+const eq_js_1 = require("../u8a/eq.js");
+const u8a_js_1 = require("./u8a.js");
+const ELF_MAGIC = new Uint8Array([0x7f, 0x45, 0x4c, 0x46]); // ELF magic bytes: 0x7f, 'E', 'L', 'F'
+const PVM_MAGIC = new Uint8Array([0x50, 0x56, 0x4d, 0x00]); // 'P', 'V', 'M', 0x00
+/**
+ * @name isRiscV
+ * @summary Tests if the input has a RISC-V header
+ * @description
+ * Checks to see if the input Uint8Array contains a valid RISC-V header
+ */
+function isRiscV(bytes) {
+    if ((0, u8a_js_1.isU8a)(bytes)) {
+        const start = bytes.subarray(0, 4);
+        return (0, eq_js_1.u8aEq)(start, PVM_MAGIC) || (0, eq_js_1.u8aEq)(start, ELF_MAGIC);
+    }
+    return false;
+}

package/build/cjs/is/string.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name isString
+ * @summary Tests for a string.
+ * @description
+ * Checks to see if the input value is a JavaScript string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isString } from '@pezkuwi/util';
+ *
+ * console.log('isString', isString('test')); // => true
+ * ```
+ */
+export declare function isString(value: unknown): value is AnyString;

package/build/cjs/is/string.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = isString;
+/**
+ * @name isString
+ * @summary Tests for a string.
+ * @description
+ * Checks to see if the input value is a JavaScript string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isString } from '@pezkuwi/util';
+ *
+ * console.log('isString', isString('test')); // => true
+ * ```
+ */
+function isString(value) {
+    return typeof value === 'string' || value instanceof String;
+}

package/build/cjs/is/testChain.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTestChain = isTestChain;
+const REGEX_DEV = /(Development|Local Testnet)$/;
+function isTestChain(chain) {
+    if (!chain) {
+        return false;
+    }
+    return !!REGEX_DEV.test(chain.toString());
+}

package/build/cjs/is/toBigInt.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isToBigInt = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isToBigInt = (0, helpers_js_1.isOn)('toBigInt');

package/build/cjs/is/toBn.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isToBn = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isToBn = (0, helpers_js_1.isOn)('toBn');

package/build/cjs/is/u8a.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name isU8a
+ * @summary Tests for a `Uint8Array` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `Uint8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUint8Array } from '@pezkuwi/util';
+ *
+ * console.log('isU8a', isU8a([])); // => false
+ * ```
+ */
+export declare function isU8a(value?: unknown): value is Uint8Array;

package/build/cjs/is/u8a.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isU8a = isU8a;
+/**
+ * @name isU8a
+ * @summary Tests for a `Uint8Array` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `Uint8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUint8Array } from '@pezkuwi/util';
+ *
+ * console.log('isU8a', isU8a([])); // => false
+ * ```
+ */
+function isU8a(value) {
+    // here we defer the instanceof check which is actually slightly
+    // slower than just checking the constrctor (direct instances)
+    return (((value && value.constructor) === Uint8Array) ||
+        value instanceof Uint8Array);
+}

package/build/cjs/is/undefined.d.ts

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

package/build/cjs/is/undefined.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUndefined = isUndefined;
+/**
+ * @name isUndefined
+ * @summary Tests for a `undefined` values.
+ * @description
+ * Checks to see if the input value is `undefined`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUndefined } from '@pezkuwi/util';
+ *
+ * console.log('isUndefined', isUndefined(void(0))); // => true
+ * ```
+ */
+function isUndefined(value) {
+    return value === undefined;
+}