@pezkuwi/util 14.0.12 → 14.0.14

package/build-tsc/hex/hasPrefix.d.ts

@@ -1,16 +0,0 @@
-import type { HexString } from '../types.js';
-/**
- * @name hexHasPrefix
- * @summary Tests for the existence of a `0x` prefix.
- * @description
- * Checks for a valid hex input value and if the start matched `0x`
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexHasPrefix } from '@pezkuwi/util';
- *
- * console.log('has prefix', hexHasPrefix('0x1234')); // => true
- * ```
- */
-export declare function hexHasPrefix(value?: string | null): value is HexString;

package/build-tsc/hex/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * @summary Internal utilities to create and test for hex values
- */
-export { hexAddPrefix } from './addPrefix.js';
-export { hexFixLength } from './fixLength.js';
-export { hexHasPrefix } from './hasPrefix.js';
-export { hexStripPrefix } from './stripPrefix.js';
-export { hexToBigInt } from './toBigInt.js';
-export { hexToBn } from './toBn.js';
-export { hexToNumber } from './toNumber.js';
-export { hexToString } from './toString.js';
-export { hexToU8a } from './toU8a.js';

package/build-tsc/hex/stripPrefix.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name hexStripPrefix
- * @summary Strips any leading `0x` prefix.
- * @description
- * Tests for the existence of a `0x` prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexStripPrefix } from '@pezkuwi/util';
- *
- * console.log('stripped', hexStripPrefix('0x1234')); // => 1234
- * ```
- */
-export declare function hexStripPrefix(value?: string | null): string;

package/build-tsc/hex/toBigInt.d.ts

@@ -1,6 +0,0 @@
-import type { ToBnOptions } from '../types.js';
-/**
- * @name hexToBigInt
- * @summary Creates a BigInt instance object from a hex string.
- */
-export declare function hexToBigInt(value?: string | null, { isLe, isNegative }?: ToBnOptions): bigint;

package/build-tsc/hex/toBn.d.ts

@@ -1,21 +0,0 @@
-import type { ToBnOptions } from '../types.js';
-import { BN } from '../bn/bn.js';
-/**
- * @name hexToBn
- * @summary Creates a BN.js object from a hex string.
- * @description
- * `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @param _value The value to convert
- * @param _options Options to pass while converting
- * @param _options.isLe Convert using Little Endian
- * @param _options.isNegative Convert using two's complement
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToBn } from '@pezkuwi/util';
- *
- * hexToBn('0x123480001f'); // => BN(0x123480001f)
- * ```
- */
-export declare function hexToBn(value?: string | null, { isLe, isNegative }?: ToBnOptions): BN;

package/build-tsc/hex/toNumber.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name hexToNumber
- * @summary Creates a Number value from a Buffer object.
- * @description
- * `null` inputs returns an NaN result, `hex` values return the actual value as a `Number`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToNumber } from '@pezkuwi/util';
- *
- * hexToNumber('0x1234'); // => 0x1234
- * ```
- */
-export declare function hexToNumber(value?: string | null): number;

package/build-tsc/hex/toString.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * Hex input values return the actual bytes value converted to a string. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToString } from '@pezkuwi/util';
- *
- * hexToU8a('0x68656c6c6f'); // hello
- * ```
- */
-export declare function hexToString(_value?: string | null): string;

package/build-tsc/hex/toU8a.d.ts

@@ -1,16 +0,0 @@
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToU8a } from '@pezkuwi/util';
- *
- * hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
- * hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
- * ```
- */
-export declare function hexToU8a(value?: string | null, bitLength?: number): Uint8Array;

package/build-tsc/hex/toU8aBuffer.d.ts

@@ -1,16 +0,0 @@
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToU8a } from '@pezkuwi/util';
- *
- * hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
- * hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
- * ```
- */
-export declare function hexToU8a(_value?: string | null, bitLength?: number): Uint8Array;

package/build-tsc/index.d.ts

@@ -1,2 +0,0 @@
-import './packageDetect.js';
-export * from './bundle.js';

package/build-tsc/is/array.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name isArray
- * @summary Tests for a Array instance.
- */
-export declare function isArray<T>(value?: unknown): value is T[];

package/build-tsc/is/ascii.d.ts

@@ -1,8 +0,0 @@
-import type { U8aLike } from '../types.js';
-/**
- * @name isAscii
- * @summary Tests if the input is printable ASCII
- * @description
- * Checks to see if the input string or Uint8Array is printable ASCII, 32-127 + formatters
- */
-export declare function isAscii(value?: U8aLike | null): boolean;

package/build-tsc/is/bigInt.d.ts

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

package/build-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/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-tsc/is/object.d.ts

@@ -1,18 +0,0 @@
-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-tsc/is/observable.d.ts

@@ -1,16 +0,0 @@
-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-tsc/is/promise.d.ts

@@ -1 +0,0 @@
-export declare const isPromise: (value?: unknown) => value is Promise<unknown>;

package/build-tsc/is/riscv.d.ts

@@ -1,7 +0,0 @@
-/**
- * @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
- */
-export declare function isRiscV(bytes: unknown): bytes is Uint8Array;

package/build-tsc/is/string.d.ts

@@ -1,16 +0,0 @@
-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-tsc/is/testChain.d.ts

@@ -1 +0,0 @@
-export declare function isTestChain(chain?: string | null): boolean;

package/build-tsc/is/toBigInt.d.ts

@@ -1,2 +0,0 @@
-import type { ToBigInt } from '../types.js';
-export declare const isToBigInt: (value?: unknown) => value is ToBigInt;

package/build-tsc/is/toBn.d.ts

@@ -1,2 +0,0 @@
-import type { ToBn } from '../types.js';
-export declare const isToBn: (value?: unknown) => value is ToBn;

package/build-tsc/is/u8a.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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-tsc/is/undefined.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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-tsc/is/utf8.d.ts

@@ -1,7 +0,0 @@
-/**
- * @name isUtf8
- * @summary Tests if the input is valid Utf8
- * @description
- * Checks to see if the input string or Uint8Array is valid Utf8
- */
-export declare function isUtf8(value?: number[] | Uint8Array | string | null): boolean;

package/build-tsc/is/wasm.d.ts

@@ -1,7 +0,0 @@
-/**
- * @name isWasm
- * @summary Tests if the input has a WASM header
- * @description
- * Checks to see if the input Uint8Array contains a valid WASM header
- */
-export declare function isWasm(value?: unknown): value is Uint8Array;

package/build-tsc/lazy.d.ts

@@ -1,14 +0,0 @@
-type AnyFn = (...args: unknown[]) => unknown;
-/**
- * @name lazyMethod
- * @description
- * Creates a lazy, on-demand getter for the specific value. Upon get the value will be evaluated.
- */
-export declare function lazyMethod<T, K, S>(result: Record<string, T> | AnyFn, item: K, creator: (item: K, index: number, self: S) => T, getName?: (item: K, index: number) => string, index?: number): void;
-/**
- * @name lazyMethods
- * @description
- * Creates lazy, on-demand getters for the specific values.
- */
-export declare function lazyMethods<T, K, S>(result: Record<string, T>, items: readonly K[], creator: (item: K, index: number, self: S) => T, getName?: (item: K, index: number) => string): Record<string, T>;
-export {};

package/build-tsc/logger.d.ts

@@ -1,17 +0,0 @@
-import type { Logger } from './types.js';
-export declare function loggerFormat(value: unknown): unknown;
-/**
- * @name Logger
- * @summary Creates a consistent log interface for messages
- * @description
- * Returns a `Logger` that has `.log`, `.error`, `.warn` and `.debug` (controlled with environment `DEBUG=typeA,typeB`) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.
- * @example
- * <BR>
- *
- * ```javascript
- * import { logger } from '@pezkuwi/util';
- *
- * const l = logger('test');
- * ```
- */
-export declare function logger(origin: string): Logger;