@xylabs/sdk-js

*

`Type Parameters`

`$3`

`Constructors`

`$3`

`ts new ApiEndpoint(config, path): ApiEndpoint;`

`$3`

#### config

ApiConfig

#### path

string

`$3`

ApiEndpoint\<T\>

`Accessors`

`$3`

`ts get value(): undefined | T;`

#### Returns

undefined \| T

`Methods`

`$3`

`ts fetch(): Promise;`

`$3`

Promise\<T\>

*

`$3`

`ts get(): Promise>;`

`$3`

Promise\<T \| NonNullable\<T\>\>

*

`$3`

`ts insert(value): Promise;`

`$3`

#### value

`$3`

Promise\<T\>

### AxiosJson

*

`Extends`

- Axios

`Constructors`

`$3`

`ts new AxiosJson(config?): AxiosJson;`

`$3`

#### config?

RawAxiosJsonRequestConfig\<any\>

`$3`

AxiosJson

`$3`

`ts Axios.constructor`

`Properties`

`$3`

`ts static optional defaultLogger: Logger;`

`Methods`

`$3`

`ts static finalPath(response): any;`

`$3`

#### response

AxiosResponse

`$3`

any

### AxiosJsonUncompressed

*

`Extends`

- Axios

`Constructors`

`$3`

`ts new AxiosJsonUncompressed(config?): AxiosJsonUncompressed;`

`$3`

#### config?

RawAxiosJsonRequestUncompressedConfig\<any\>

`$3`

AxiosJsonUncompressed

`$3`

`ts Axios.constructor`

`Properties`

`$3`

`ts static optional defaultLogger: Logger;`

`Methods`

`$3`

`ts static finalPath(response): any;`

`$3`

#### response

AxiosResponse

`$3`

any

### ConsoleLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Extends`

- LevelLogger

`Constructors`

`$3`

`ts new ConsoleLogger(level?): ConsoleLogger;`

`$3`

#### level?

`$3`

ConsoleLogger

`$3`

LevelLogger.constructor

`Properties`

`$3`

`ts readonly level: LogLevelValue;`

`$3`

LevelLogger.level

*

`$3`

`ts readonly logger: Logger;`

`$3`

LevelLogger.logger

`Accessors`

`$3`

`ts get debug(): LogFunction;`

#### Returns

`$3`

LevelLogger.debug

*

`$3`

`ts get error(): LogFunction;`

#### Returns

`$3`

LevelLogger.error

*

`$3`

`ts get info(): LogFunction;`

#### Returns

`$3`

LevelLogger.info

*

`$3`

`ts get log(): LogFunction;`

#### Returns

`$3`

LevelLogger.log

*

`$3`

`ts get trace(): LogFunction;`

#### Returns

`$3`

LevelLogger.trace

*

`$3`

`ts get warn(): LogFunction;`

#### Returns

`$3`

LevelLogger.warn

### EthAddress

*

`Properties`

`$3`

`ts readonly static type: "EthAddress" = "EthAddress";`

*

`$3`

`ts type: string;`

`Methods`

`$3`

`ts static fromString(value?, base?): undefined | EthAddress;`

`$3`

#### value?

string

#### base?

number

`$3`

undefined \| EthAddress

*

`$3`

`ts static parse(value, base?): undefined | EthAddress;`

`$3`

#### value

unknown

#### base?

number

`$3`

undefined \| EthAddress

*

`$3`

`ts static validate(address): boolean;`

`$3`

#### address

string

`$3`

boolean

*

`$3`

`ts equals(address?): boolean;`

`$3`

#### address?

null | string | EthAddress

`$3`

boolean

*

`$3`

`ts toBigNumber(): bigint;`

`$3`

bigint

*

`$3`

`ts toHex(): string;`

`$3`

string

*

`$3`

`ts toJSON(): string;`

`$3`

string

*

`$3`

`ts toLowerCaseString(): string;`

`$3`

string

*

`$3`

`ts toShortString(length?): string;`

`$3`

#### length?

number

`$3`

string

*

`$3`

`ts toString(checksum?, chainId?): string;`

`$3`

#### checksum?

boolean

#### chainId?

string

`$3`

string

*

`$3`

`ts validate(): boolean;`

`$3`

boolean

### ForgetPromise

*

`Extends`

- ForgetPromise

`Constructors`

`$3`

`ts new ForgetPromise(): ForgetPromiseNode;`

`$3`

ForgetPromiseNode

`$3`

`ts ForgetPromise.constructor`

`Properties`

`$3`

`ts static activeForgets: number;`

`$3`

`ts ForgetPromise.activeForgets`

*

`$3`

`ts static exceptedForgets: number;`

`$3`

`ts ForgetPromise.exceptedForgets`

*

`$3`

`ts static logger: Logger;`

`$3`

`ts ForgetPromise.logger`

`Accessors`

`$3`

`ts get static active(): boolean;`

#### Returns

boolean

`$3`

`ts ForgetPromise.active`

`Methods`

`$3`

`ts static awaitInactive(interval?, timeout?): Promise;`

`$3`

#### interval?

number

#### timeout?

number

`$3`

Promise\<number\>

`$3`

`ts ForgetPromise.awaitInactive`

*

`$3`

`ts static exceptionHandler( error, config, externalStackTrace?): void;`

`$3`

#### error

Error

#### config

#### externalStackTrace?

string

`$3`

void

`$3`

`ts ForgetPromise.exceptionHandler`

*

`$3`

`ts static forget(promise, config?): void;`

Used to explicitly launch an async function (or Promise) with awaiting it

`$3`

#### T

`$3`

#### promise

Promisable\<T\>

The promise to forget

#### config?

ForgetNodeConfig\<T\>

Configuration of forget settings

`$3`

void

`$3`

`ts ForgetPromise.forget`

*

`$3`

`ts static timeoutHandler( time, config, externalStackTrace?): void;`

`$3`

#### time

number

#### config

#### externalStackTrace?

string

`$3`

void

`$3`

`ts ForgetPromise.timeoutHandler`

### IdLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Implements`

- Logger

`Constructors`

`$3`

`ts new IdLogger(logger, id?): IdLogger;`

`$3`

#### logger

#### id?

() => string

`$3`

IdLogger

`Accessors`

`$3`

`ts set id(id): void;`

#### Parameters

##### id

string

#### Returns

void

`Methods`

`$3`

`ts debug(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.debug`

*

`$3`

`ts error(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.error`

*

`$3`

`ts info(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.info`

*

`$3`

`ts log(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.log`

*

`$3`

`ts trace(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.trace`

*

`$3`

`ts warn(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.warn`

### IsObjectFactory

*

`Type Parameters`

`$3`

T extends TypedObject

`Constructors`

`$3`

`ts new IsObjectFactory(): IsObjectFactory;`

`$3`

IsObjectFactory\<T\>

`Methods`

`$3`

`ts create(shape?, additionalChecks?): TypeCheck;`

`$3`

#### shape?

ObjectTypeShape

#### additionalChecks?

TypeCheck\<TypedObject\>[]

`$3`

TypeCheck\<T\>

### LevelLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Extended by`

- ConsoleLogger

`Implements`

- Logger

`Constructors`

`$3`

`ts new LevelLogger(logger, level?): LevelLogger;`

`$3`

#### logger

#### level?

`$3`

LevelLogger

`Properties`

`$3`

`ts readonly level: LogLevelValue;`

*

`$3`

`ts readonly logger: Logger;`

`Accessors`

`$3`

`ts get debug(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get error(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get info(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get log(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get trace(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get warn(): LogFunction;`

#### Returns

`$3`

### Log

*

`Deprecated`

use @xylabs/logger instead

`Constructors`

`$3`

`ts new Log(config): Log;`

`$3`

#### config

LogConfig

`$3`

Log

`Properties`

`$3`

`ts protected config: LogConfig;`

`Methods`

`$3`

`ts debug(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts error(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts info(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts log(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts warn(...params): void;`

`$3`

#### params

...any[]

`$3`

void

### ObjectWrapper

*

`Extended by`

- ValidatorBase

`Type Parameters`

`$3`

T extends EmptyObject = EmptyObject

`Constructors`

`$3`

`ts new ObjectWrapper(obj): ObjectWrapper;`

`$3`

#### obj

`$3`

ObjectWrapper\<T\>

`Properties`

`$3`

`ts readonly obj: T;`

`Accessors`

`$3`

`ts get protected stringKeyObj(): StringKeyObject;`

#### Returns

### PromiseEx

*

`Extends`

- Promise\<T\>

`Type Parameters`

`$3`

V = void

`Constructors`

`$3`

`ts new PromiseEx(func, value?): PromiseEx;`

`$3`

#### func

PromiseExFunc\<T\>

#### value?

`$3`

PromiseEx\<T, V\>

`$3`

`ts Promise.constructor`

`Properties`

`$3`

`ts optional cancelled: boolean;`

`Methods`

`$3`

`ts then( onfulfilled?, onrejected?, onvalue?): Promise;`

Attaches callbacks for the resolution and/or rejection of the Promise.

`$3`

#### TResult1

TResult1 = T

#### TResult2

TResult2 = never

`$3`

#### onfulfilled?

The callback to execute when the Promise is resolved.

null | (value) => TResult1 \| PromiseLike\<TResult1\>

#### onrejected?

The callback to execute when the Promise is rejected.

null | (reason) => TResult2 \| PromiseLike\<TResult2\>

#### onvalue?

(value?) => boolean

`$3`

Promise\<TResult1 \| TResult2\>

A Promise for the completion of which ever callback is executed.

`$3`

`ts Promise.then`

*

`$3`

`ts value(onvalue?): this;`

`$3`

#### onvalue?

(value?) => boolean

`$3`

this

### SilentLogger

*

A logger that does not log anything. This is useful when you want to disable logging like when running unit tests or in silent mode. It implements theLoggerinterface but all methods are no-op functions.

`Implements`

- Logger

`Constructors`

`$3`

`ts new SilentLogger(): SilentLogger;`

`$3`

SilentLogger

`Properties`

`$3`

`ts readonly debug: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly error: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly info: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly log: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly trace: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly warn: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

### ValidatorBase

*

`Extends`

- ObjectWrapper\<Partial\<T\>\>

`Type Parameters`

`$3`

T extends EmptyObject = AnyObject

`Implements`

- Validator\<T\>

`Constructors`

`$3`

`ts new ValidatorBase(obj): ValidatorBase;`

`$3`

#### obj

`$3`

ValidatorBase\<T\>

`$3`

ObjectWrapper.constructor

`Properties`

`$3`

`ts readonly obj: T;`

`$3`

ObjectWrapper.obj

`Accessors`

`$3`

`ts get protected stringKeyObj(): StringKeyObject;`

#### Returns

`$3`

ObjectWrapper.stringKeyObj

`Methods`

`$3`

`ts abstract validate(payload): Promisable;`

`$3`

#### payload

`$3`

Promisable\<Error[]\>

`$3`

Validator.validate

`$3`

### asAddress

*

`Call Signature`

`ts function asAddress(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asAddress(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### asHash

*

`Call Signature`

`ts function asHash(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asHash(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### asHex

*

`Call Signature`

`ts function asHex(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asHex(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### assertDefinedEx

*

`Call Signature`

`ts function assertDefinedEx(expr, messageFunc?): T;`

Intended for defined checks for variables

`$3`

Expression to be evaluated for truthiness

undefined | T

`$3`

AssertExMessageFunc\<T\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertDefinedEx(expr, errorFunc?): T;`

Intended for defined checks for variables

`$3`

R extends Error

`$3`

Expression to be evaluated for truthiness

undefined | T

`$3`

AssertExErrorFunc\<T, R\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertDefinedEx(expr): T;`

`$3`

undefined | T

`$3`

- passing a message will soon be required

`Call Signature`

`ts function assertDefinedEx(expr, message?): T;`

`$3`

undefined | T

`$3`

string

`$3`

- replace string with () => string

### assertEx

*

`Call Signature`

`ts function assertEx(expr, messageFunc?): T;`

Intended for simple truthiness checks for variables

`$3`

Expression to be evaluated for truthiness

undefined | null | T

`$3`

AssertExMessageFunc\<T\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertEx(expr, errorFunc?): T;`

Intended for simple truthiness checks for variables

`$3`

R extends Error

`$3`

Expression to be evaluated for truthiness

undefined | null | T

`$3`

AssertExErrorFunc\<T, R\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertEx(expr): T;`

`$3`

undefined | null | T

`$3`

- passing a message will soon be required

`Call Signature`

`ts function assertEx(expr, message?): T;`

`$3`

undefined | null | T

`$3`

string

`$3`

- replace string with () => string

### createDeepMerge

*

`ts function createDeepMerge(options): (...objects) => MergeAll;`

Creates a deep merge function with the specified options.

`Parameters`

`$3`

MergeOptions

Options for merging.

`Returns`

A deep merge function configured for the specified options.

`ts (...objects): MergeAll;`

`$3`

T extends AnyObject[]

`$3`

...T

`$3`

MergeAll\<T\>

### hexToBigInt

*

`ts function hexToBigInt(hex): bigint;`

`Parameters`

`$3`

Lowercase\<string\>

`Returns`

bigint

### staticImplements

*

`ts function staticImplements(): (constructor) => void;`

Annotation to decorate classes which implement static methods

`Type Parameters`

`$3`

`Returns`

The decorated class requiring it to implement the members of the the type as static properties/methods

`ts (constructor): void;`

`$3`

void

### toPromise

*

`ts function toPromise(value): Promise;`

`Type Parameters`

`$3`

`Parameters`

`$3`

Promisable\<T\>

`Returns`

Promise\<T\>

`$3`

### ApiConfig

*

`Properties`

`$3`

`ts apiDomain: string;`

*

`$3`

`ts optional apiKey: string;`

*

`$3`

`ts optional jwtToken: string;`

*

`$3`

`ts optional userid: string;`

### ForgetNodeConfig

*

`Extends`

- ForgetConfig\<T\>

`Type Parameters`

`$3`

T = any

`Properties`

`$3`

`ts optional name: string;`

`$3`

`ts ForgetConfig.name`

*

`$3`

`ts optional onCancel: () => void;`

`$3`

void

`$3`

`ts ForgetConfig.onCancel`

*

`$3`

`ts optional onComplete: (result) => void;`

`$3`

#### result

\[undefined \| T, undefined \| Error\]

`$3`

void

`$3`

`ts ForgetConfig.onComplete`

*

`$3`

`ts optional onException: (error) => void;`

`$3`

#### error

Error

`$3`

void

`$3`

`ts ForgetConfig.onException`

*

`$3`

`ts optional timeout: number;`

`$3`

`ts ForgetConfig.timeout`

*

`$3`

`ts optional terminateOnException: boolean;`

*

`$3`

`ts optional terminateOnTimeout: boolean;`

### HexConfig

*

Configuration of validation and output format

`Properties`

`$3`

`ts optional bitLength: number;`

*

`$3`

`ts optional byteSize: number;`

*

`$3`

`ts optional prefix: boolean;`

### Logger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Properties`

`$3`

`ts debug: LogFunction;`

*

`$3`

`ts error: LogFunction;`

*

`$3`

`ts info: LogFunction;`

*

`$3`

`ts log: LogFunction;`

*

`$3`

`ts trace: LogFunction;`

*

`$3`

`ts warn: LogFunction;`

### ObjectTypeConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

### PromiseType

*

`Properties`

`$3`

`ts then: () => unknown;`

`$3`

unknown

### RetryConfig

*

`Extended by`

- RetryConfigWithComplete

`Properties`

`$3`

`ts optional backoff: number;`

*

`$3`

`ts optional interval: number;`

*

`$3`

`ts optional retries: number;`

### RetryConfigWithComplete

*

`Extends`

- RetryConfig

`Type Parameters`

`$3`

T = unknown

`Properties`

`$3`

`ts optional backoff: number;`

`$3`

RetryConfig.backoff

*

`$3`

`ts optional interval: number;`

`$3`

RetryConfig.interval

*

`$3`

`ts optional retries: number;`

`$3`

RetryConfig.retries

*

`$3`

`ts optional complete: (result?) => boolean;`

`$3`

#### result?

`$3`

boolean

### TypeCheckConfig

*

`Extended by`

- ObjectTypeConfig-TypeCheckRequiredConfig-TypeCheckOptionalConfig

`Properties`

`$3`

`ts optional log: boolean | Logger;`

### TypeCheckOptionalConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

*

`$3`

`ts required: false;`

### TypeCheckRequiredConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

*

`$3`

`ts required: true;`

### Validator

*

`Type Parameters`

`$3`

T extends EmptyObject = AnyObject

`Methods`

`$3`

`ts validate(payload): Promisable;`

`$3`

#### payload

`$3`

Promisable\<Error[]\>

`$3`

### Address

*

`ts type Address = Exclude;`

### AnyNonPromise

*

`ts type AnyNonPromise = Exclude;`

### AnyObject

*

`ts type AnyObject = Record;`

Any object, which means that it does not enforce the set of fields that it has. Extending from AnyObject will result in a type that includes the universal set of field names

### ApiStage

*

`ts type ApiStage = EnumValue;`

### AsOptionalTypeFunction

*

`ts type AsOptionalTypeFunction = (value) => undefined | TType;`

`Type Parameters`

`$3`

T extends AnyNonPromise = AnyNonPromise

`Type Parameters`

`$3`

TType extends AnyNonPromise

`Parameters`

`$3`

`Returns`

undefined \| TType

### AsTypeFunction

*

`ts type AsTypeFunction = { (value): undefined | TType; (value, config): TType; (value, config): undefined | TType; (value, assert): undefined | TType; (value, assert, config): TType; (value, assert, config): undefined | TType; };`

`Type Parameters`

`$3`

T extends AnyNonPromise = AnyNonPromise

`Call Signature`

`ts (value): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

undefined \| TType

`Call Signature`

`ts (value, config): TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

`$3`

TType

`Call Signature`

`ts (value, config): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

`$3`

undefined \| TType

`Call Signature`

`ts (value, assert): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

undefined \| TType

`Call Signature`

`ts ( value, assert, config): TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

`$3`

TType

`Call Signature`

`ts ( value, assert, config): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

`$3`

undefined \| TType

### AssertExErrorFunc

*

`ts type AssertExErrorFunc = (value?) => R;`

`Type Parameters`

`$3`

R extends Error

`Parameters`

`$3`

T | null

`Returns`

### AssertExMessageFunc

*

`ts type AssertExMessageFunc = (value?) => string;`

`Type Parameters`

`$3`

`Parameters`

`$3`

T | null

`Returns`

string

### AsyncMutex

*

`ts type AsyncMutex = Promise;`

`Type Parameters`

`$3`

`Description`

Used to document promises that are being used as Mutexes

### Compare

*

`ts type Compare = (a, b) => number;`

`Type Parameters`

`$3`

`Parameters`

`$3`

`Returns`

number

### DeepOmitStartsWith

*

`ts type DeepOmitStartsWith = T extends infer U[] ? DeepOmitStartsWith[] : T extends object ? { [K in keyof T as K extends string ? K extends${Prefix}${string}? never : K : K]: DeepOmitStartsWith } : T;`

`Type Parameters`

`$3`

Prefix extends string

### DeepPickStartsWith

*

`ts type DeepPickStartsWith = T extends infer U[] ? DeepPickStartsWith[] : T extends object ? { [K in keyof T as K extends string ? K extends${Prefix}${string}? K : never : K]: DeepPickStartsWith } : T;`

`Type Parameters`

`$3`

Prefix extends string

### DeepRestrictToStringKeys

*

`ts type DeepRestrictToStringKeys = { [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys[] : T[K] extends object ? DeepRestrictToStringKeys : T[K] };`

`Type Parameters`

`$3`

### EmptyObject

*

`ts type EmptyObject = { [K in keyof T]?: never };`

An empty object, which means that it does enforce the set of field names, defaulting to an empty set until extended from, which then adds only those additional fields

`Type Parameters`

`$3`

T extends object = object

### EmptyObjectOf

*

`ts type EmptyObjectOf = EmptyObject extends T ? EmptyObject : never;`

`Type Parameters`

`$3`

T extends object

### Hash

*

`ts type Hash = Exclude;`

### HashBitLength

*

`ts type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;`

### Hex

*

`ts type Hex = Exclude, "reserved-hex-value">;`

### JsonArray

*

`ts type JsonArray = JsonValue[];`

### JsonObject

*

`ts type JsonObject = object;`

`Index Signature`

`ts [key: string]: JsonValue`

### JsonValue

*

### LogFunction

*

`ts type LogFunction = (...data) => void;`

`Parameters`

`$3`

...unknown[]

`Returns`

void

### LogLevel

*

`ts type LogLevel = LogLevelValue;`

`Deprecated`

Use LogLevelValueinstead. This name conflicts with theLogLevelenum and makes it confusing to import

### LogLevelKey

*

`ts type LogLevelKey = EnumKey;`

### LogLevelValue

*

`ts type LogLevelValue = EnumValue;`

### LogVerbosity

*

`ts type LogVerbosity = LogLevelKey;`

### NullablePromisable

*

`ts type NullablePromisable = Promisable;`

`Type Parameters`

`$3`

V = never

### NullablePromisableArray

*

`ts type NullablePromisableArray = PromisableArray;`

`Type Parameters`

`$3`

V = never

### OmitByPredicate

*

`ts type OmitByPredicate = (value, key) => boolean;`

`Type Parameters`

`$3`

T extends EmptyObject = Record\<string, unknown\>

`Parameters`

`$3`

T\[keyof T\]

`$3`

keyof T

`Returns`

boolean

### OmitStartsWith

*

`ts type OmitStartsWith = { [K in keyof T as K extends${Prefix}${string}? never : K]: T[K] };`

`Type Parameters`

`$3`

Prefix extends string

### Optional

*

`ts type Optional = Omit & Partial>;`

`Type Parameters`

`$3`

T extends object

`$3`

F extends keyof T

### OptionalPromisable

*

`ts type OptionalPromisable = Promisable;`

`Type Parameters`

`$3`

V = never

### OptionalPromisableArray

*

`ts type OptionalPromisableArray = PromisableArray;`

`Type Parameters`

`$3`

V = never

### Override

*

`ts type Override = Omit & T2;`

`Type Parameters`

`$3`

### PartialRecord

*

`ts type PartialRecord = { [P in K]?: T };`

`Type Parameters`

`$3`

K extends keyof any

`$3`

`Deprecated`

use Partial> instead

### PickByPredicate

*

`ts type PickByPredicate = (value, key) => boolean;`

`Type Parameters`

`$3`

T extends EmptyObject = Record\<string, unknown\>

`Parameters`

`$3`

T\[keyof T\]

`$3`

keyof T

`Returns`

boolean

### PickStartsWith

*

`ts type PickStartsWith = { [K in keyof T as K extends${Prefix}${string}? K : never]: T[K] };`

`Type Parameters`

`$3`

Prefix extends string

### Profiler

*

`ts type Profiler = Record;`

### Promisable

*

`ts type Promisable = PromiseEx | Promise | T;`

`Type Parameters`

`$3`

V = never

### PromisableArray

*

`ts type PromisableArray = Promisable;`

`Type Parameters`

`$3`

V = never

### PromiseExFunc

*

`ts type PromiseExFunc = (resolve?, reject?) => void;`

`Type Parameters`

`$3`

`Parameters`

`$3`

PromiseExSubFunc\<T, void\>

`$3`

PromiseExSubFunc\<T, void\>

`Returns`

void

### PromiseExSubFunc

*

`ts type PromiseExSubFunc = (value) => TResult;`

`Type Parameters`

`$3`

TResult = T

`Parameters`

`$3`

`Returns`

TResult

### PromiseExValueFunc

*

`ts type PromiseExValueFunc = (value?) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

`Returns`

boolean

### RawAxiosJsonRequestConfig

*

`ts type RawAxiosJsonRequestConfig = RawAxiosRequestConfig & object;`

`Type declaration`

`$3`

`ts optional compressLength: number;`

`Type Parameters`

`$3`

D = any

### RawAxiosJsonRequestUncompressedConfig

*

`ts type RawAxiosJsonRequestUncompressedConfig = RawAxiosRequestConfig;`

`Type Parameters`

`$3`

D = any

### StringKeyObject

*

`ts type StringKeyObject = object;`

`Type Parameters`

`$3`

T = unknown

`Index Signature`

`ts [key: string]: T`

### StringOrAlertFunction

*

`ts type StringOrAlertFunction = string | AssertExMessageFunc;`

`Type Parameters`

`$3`

T extends AnyNonPromise

### TypeCheck

*

`ts type TypeCheck = { (obj): obj is T; (obj, config): obj is T; (obj, config): obj is T; };`

`Type Parameters`

`$3`

T extends TypedValue

`Call Signature`

`ts (obj): obj is T;`

`$3`

`$3`

obj is T

`Call Signature`

`ts (obj, config): obj is T;`

`$3`

`$3`

TypeCheckConfig

`$3`

obj is T

`Call Signature`

`ts (obj, config): obj is T;`

`$3`

`$3`

undefined | number | TypeCheckConfig

`$3`

obj is T

### WithAdditional

*

`ts type WithAdditional = TAdditional extends EmptyObject ? T & TAdditional : T;`

`Type Parameters`

`$3`

T extends EmptyObject \| void

`$3`

TAdditional extends EmptyObject \| void = void

`$3`

### ApiStage

*

`ts const ApiStage: Enum<{ Beta: "beta"; Local: "local"; Prod: "prod"; }>;`

### AsObjectFactory

*

`ts const AsObjectFactory: object;`

`Type declaration`

`$3`

`ts create: (typeCheck) => AsTypeFunction;`

`$3`

#### T

T extends TypedObject

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

AsTypeFunction

`$3`

`ts createOptional: (typeCheck) => (value) => T | undefined;`

`$3`

#### T

T extends TypedObject

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

`ts (value): T | undefined;`

#### Parameters

##### value

#### Returns

T \| undefined

### AsTypeFactory

*

`ts const AsTypeFactory: object;`

`Type declaration`

`$3`

`ts create: (typeCheck) => AsTypeFunction;`

`$3`

#### T

T extends AnyNonPromise

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

AsTypeFunction\<T\>

`$3`

`ts createOptional: (typeCheck) => (value) => T | undefined;`

`$3`

#### T

T extends AnyNonPromise

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

`ts (value): T | undefined;`

#### Parameters

##### value

#### Returns

T \| undefined

### HashBitLength

*

`ts HashBitLength: HashBitLength[];`

### LogLevel

*

`ts const LogLevel: Enum<{ error: 1; warn: 2; info: 3; log: 4; debug: 5; trace: 6; }>;`

### NoOpLogFunction

*

`ts const NoOpLogFunction: (..._data) => undefined;`

`Parameters`

`$3`

...unknown[]

`Returns`

undefined

### ZERO_ADDRESS

*

`ts const ZERO_ADDRESS: Address;`

### ZERO_HASH

*

`ts const ZERO_HASH: Hash;`

### asAnyObject

*

`ts const asAnyObject: AsTypeFunction;`

### axios

*

`ts const axios: AxiosJson;`

### axiosUncompressed

*

`ts const axiosUncompressed: AxiosJsonUncompressed;`

### bitsToNibbles

*

`ts const bitsToNibbles: (value) => number;`

`Parameters`

`$3`

number

`Returns`

number

### clearTimeoutEx

*

`ts const clearTimeoutEx: (id) => void;`

`Parameters`

`$3`

string

`Returns`

void

### containsAll

*

`ts const containsAll: (source, target) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

`$3`

T[]

`Returns`

boolean

### createProfiler

*

`ts const createProfiler: () => Profiler;`

`Returns`

Profiler

### deepMerge

*

`ts const deepMerge: (...objects) => MergeAll;`

Deeply merges multiple objects into a new object.

`Type Parameters`

`$3`

T extends AnyObject[]

`Parameters`

`$3`

...T

Multiple objects to merge deeply. The function merges properties from all objects into a new object. If a property exists in multiple objects, the last object's value will be used. If a property is an object, it will be merged recursively. If a property is an array, it will be overwritten by the last object's value. If a property is a primitive value, it will be overwritten by the last object's value. If a property is undefined in the source, it will be skipped. If a property is a symbol, it will be merged as well.

`Returns`

MergeAll\<T\>

A new object with the merged properties.

### defaultForgetNodeConfig

*

`ts const defaultForgetNodeConfig: ForgetNodeConfig;`

### delay

*

`ts const delay: (ms) => Promise;`

`Parameters`

`$3`

number

`Returns`

Promise\<unknown\>

### difference

*

`ts const difference: (a, b) => Set;`

`Type Parameters`

`$3`

TKey

`Parameters`

`$3`

Set\<TKey\>

`$3`

Set\<TKey\>

`Returns`

Set\<TKey\>

### distinct

*

`ts const distinct: (value, index, array) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

number

`$3`

T[]

`Returns`

boolean

### ellipsize

*

`ts const ellipsize: (value, length?) => string;`

`Parameters`

`$3`

string

`$3`

number

`Returns`

string

### exists

*

`ts const exists: (x?) => x is NonNullable;`

Used to type narrow an object which is possibly null or undefined. Works well with functional Array methods. For example:

`Type Parameters`

`$3`

`Parameters`

`$3`

The object which is potentially undefined or null

T | null

`Returns`

x is NonNullable

False if the object is null/undefined, true otherwise

`Example`

`ts const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []`

### filterAs

*

`ts const filterAs: (x, predicate) => NonNullable[];`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\>[]

### filterAsync

*

`ts const filterAsync: (array, predicate) => Promise;`

Returns the elements of an array that meet the condition specified in a callback function.

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

The array to filter.

`$3`

(value, index, array) => Promise\<boolean\>

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

`Returns`

Promise\<T[]\>

The elements of an array that meet the condition specified in a callback function.

### findAs

*

`ts const findAs: (x, predicate) => NonNullable | undefined;`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\> \| undefined

### findLastAs

*

`ts const findLastAs: (x, predicate) => NonNullable | undefined;`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\> \| undefined

### flatten

*

`ts const flatten: (a?, b?) => T[];`

`Type Parameters`

`$3`

`Parameters`

`$3`

T | ConcatArray\<T\>

`$3`

T | ConcatArray\<T\>

`Returns`

T[]

### forget

*

`ts const forget: (promise, config?) => void;`

`Type Parameters`

`$3`

`Parameters`

`$3`

Promisable\<T\>

`$3`

ForgetNodeConfig\<T\>

`Returns`

void

### fromFixedPoint

*

`ts const fromFixedPoint: (value, places?) => bigint;`

`Parameters`

`$3`

bigint

`$3`

number

`Returns`

bigint

### fulfilled

*

`ts const fulfilled: (val) => val is PromiseFulfilledResult;`

For use with Promise.allSettled to filter only successful results

`Type Parameters`

`$3`

`Parameters`

`$3`

PromiseSettledResult\<T\>

`Returns`

val is PromiseFulfilledResult

### fulfilledValues

*

`ts const fulfilledValues: (previousValue, currentValue) => T[];`

For use with Promise.allSettled to reduce to only successful result values

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

`$3`

PromiseSettledResult\<T\>

`Returns`

T[]

`Examples`

`ts const resolved = Promise.resolve('resolved') const rejected = Promise.reject('rejected') const settled = await Promise.allSettled([resolved, rejected]) const results = settled.reduce(fulfilledValues, [] as string[]) // results === [ 'resolved' ]`

### functionName

*

`ts const functionName: (depth?) => string;`

`Parameters`

`$3`

number

`Returns`

string

### getApiStage

*

`ts const getApiStage: (hostname) => "beta" | "local" | "prod";`

`Parameters`

`$3`

string

`Returns`

"beta" \| "local" \| "prod"

### getFunctionName

*

`ts const getFunctionName: (depth?) => string;`

`Parameters`

`$3`

number

`Returns`

string

### handleError

*

`ts const handleError: (error, handler) => T;`

`Type Parameters`

`$3`

`Parameters`

`$3`

any

`$3`

(error) => T

`Returns`

### handleErrorAsync

*

`ts const handleErrorAsync: (error, handler) => Promise;`

`Type Parameters`

`$3`

`Parameters`

`$3`

any

`$3`

(error) => Promise\<T\>

`Returns`

Promise\<T\>

### hexFrom

*

`ts const hexFrom: (value, config?) => Hex;`

Takes unknown value and tries our best to convert it to a hex string

`Parameters`

`$3`

string | number | bigint | ArrayBufferLike

`$3`

`Returns`

### hexFromArrayBuffer

*

`ts const hexFromArrayBuffer: (buffer, config?) => Hex;`

Convert an ArrayBuffer to a hex string

`Parameters`

`$3`

ArrayBufferLike

`$3`

`Returns`

### hexFromBigInt

*

`ts const hexFromBigInt: (value, config?) => Hex;`

Convert a bigint to a hex string

`Parameters`

`$3`

bigint

`$3`

`Returns`

### hexFromHexString

*

`ts const hexFromHexString: (value, config?) => Hex;`

`Parameters`

`$3`

string

`$3`

`Returns`

### hexFromNumber

*

`ts const hexFromNumber: (value, config?) => Hex;`

`Parameters`

`$3`

number

`$3`

`Returns`

### hexRegex

*

`ts const hexRegex: RegExp;`

### hexRegexWithPrefix

*

`ts const hexRegexWithPrefix: RegExp;`

### intersection

*

`ts const intersection: (a, b) => Set;``

@xylabs/sdk-js

[![logo][]](https://xylabs.com)

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/sdk-js

Classes

Interfaces

Type Aliases

Variables

Functions

- assertDefinedEx
- assertEx
- asAddress
- asHash
- asHex
- hexToBigInt
- createDeepMerge
- toPromise
- staticImplements

$3

### ApiClient

@xylabs/sdk-js

Constructors

$3

``ts new ApiClient(token?, stage?): ApiClient;`

`$3`

#### token?

null | string

#### stage?

ApiStage

`$3`

ApiClient

`Properties`

`$3`

`ts protected optional token: null | string;`

*

`$3`

`ts protected optional stage: ApiStage;`

`Methods`

`$3`

`ts abstract endPoint(): string;`

`$3`

string

### ApiEndpoint

*

`Type Parameters`

`$3`

`Constructors`

`$3`

`ts new ApiEndpoint(config, path): ApiEndpoint;`

`$3`

#### config

ApiConfig

#### path

string

`$3`

ApiEndpoint\<T\>

`Accessors`

`$3`

`ts get value(): undefined | T;`

#### Returns

undefined \| T

`Methods`

`$3`

`ts fetch(): Promise;`

`$3`

Promise\<T\>

*

`$3`

`ts get(): Promise>;`

`$3`

Promise\<T \| NonNullable\<T\>\>

*

`$3`

`ts insert(value): Promise;`

`$3`

#### value

`$3`

Promise\<T\>

### AxiosJson

*

`Extends`

- Axios

`Constructors`

`$3`

`ts new AxiosJson(config?): AxiosJson;`

`$3`

#### config?

RawAxiosJsonRequestConfig\<any\>

`$3`

AxiosJson

`$3`

`ts Axios.constructor`

`Properties`

`$3`

`ts static optional defaultLogger: Logger;`

`Methods`

`$3`

`ts static finalPath(response): any;`

`$3`

#### response

AxiosResponse

`$3`

any

### AxiosJsonUncompressed

*

`Extends`

- Axios

`Constructors`

`$3`

`ts new AxiosJsonUncompressed(config?): AxiosJsonUncompressed;`

`$3`

#### config?

RawAxiosJsonRequestUncompressedConfig\<any\>

`$3`

AxiosJsonUncompressed

`$3`

`ts Axios.constructor`

`Properties`

`$3`

`ts static optional defaultLogger: Logger;`

`Methods`

`$3`

`ts static finalPath(response): any;`

`$3`

#### response

AxiosResponse

`$3`

any

### ConsoleLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Extends`

- LevelLogger

`Constructors`

`$3`

`ts new ConsoleLogger(level?): ConsoleLogger;`

`$3`

#### level?

`$3`

ConsoleLogger

`$3`

LevelLogger.constructor

`Properties`

`$3`

`ts readonly level: LogLevelValue;`

`$3`

LevelLogger.level

*

`$3`

`ts readonly logger: Logger;`

`$3`

LevelLogger.logger

`Accessors`

`$3`

`ts get debug(): LogFunction;`

#### Returns

`$3`

LevelLogger.debug

*

`$3`

`ts get error(): LogFunction;`

#### Returns

`$3`

LevelLogger.error

*

`$3`

`ts get info(): LogFunction;`

#### Returns

`$3`

LevelLogger.info

*

`$3`

`ts get log(): LogFunction;`

#### Returns

`$3`

LevelLogger.log

*

`$3`

`ts get trace(): LogFunction;`

#### Returns

`$3`

LevelLogger.trace

*

`$3`

`ts get warn(): LogFunction;`

#### Returns

`$3`

LevelLogger.warn

### EthAddress

*

`Properties`

`$3`

`ts readonly static type: "EthAddress" = "EthAddress";`

*

`$3`

`ts type: string;`

`Methods`

`$3`

`ts static fromString(value?, base?): undefined | EthAddress;`

`$3`

#### value?

string

#### base?

number

`$3`

undefined \| EthAddress

*

`$3`

`ts static parse(value, base?): undefined | EthAddress;`

`$3`

#### value

unknown

#### base?

number

`$3`

undefined \| EthAddress

*

`$3`

`ts static validate(address): boolean;`

`$3`

#### address

string

`$3`

boolean

*

`$3`

`ts equals(address?): boolean;`

`$3`

#### address?

null | string | EthAddress

`$3`

boolean

*

`$3`

`ts toBigNumber(): bigint;`

`$3`

bigint

*

`$3`

`ts toHex(): string;`

`$3`

string

*

`$3`

`ts toJSON(): string;`

`$3`

string

*

`$3`

`ts toLowerCaseString(): string;`

`$3`

string

*

`$3`

`ts toShortString(length?): string;`

`$3`

#### length?

number

`$3`

string

*

`$3`

`ts toString(checksum?, chainId?): string;`

`$3`

#### checksum?

boolean

#### chainId?

string

`$3`

string

*

`$3`

`ts validate(): boolean;`

`$3`

boolean

### ForgetPromise

*

`Extends`

- ForgetPromise

`Constructors`

`$3`

`ts new ForgetPromise(): ForgetPromiseNode;`

`$3`

ForgetPromiseNode

`$3`

`ts ForgetPromise.constructor`

`Properties`

`$3`

`ts static activeForgets: number;`

`$3`

`ts ForgetPromise.activeForgets`

*

`$3`

`ts static exceptedForgets: number;`

`$3`

`ts ForgetPromise.exceptedForgets`

*

`$3`

`ts static logger: Logger;`

`$3`

`ts ForgetPromise.logger`

`Accessors`

`$3`

`ts get static active(): boolean;`

#### Returns

boolean

`$3`

`ts ForgetPromise.active`

`Methods`

`$3`

`ts static awaitInactive(interval?, timeout?): Promise;`

`$3`

#### interval?

number

#### timeout?

number

`$3`

Promise\<number\>

`$3`

`ts ForgetPromise.awaitInactive`

*

`$3`

`ts static exceptionHandler( error, config, externalStackTrace?): void;`

`$3`

#### error

Error

#### config

#### externalStackTrace?

string

`$3`

void

`$3`

`ts ForgetPromise.exceptionHandler`

*

`$3`

`ts static forget(promise, config?): void;`

Used to explicitly launch an async function (or Promise) with awaiting it

`$3`

#### T

`$3`

#### promise

Promisable\<T\>

The promise to forget

#### config?

ForgetNodeConfig\<T\>

Configuration of forget settings

`$3`

void

`$3`

`ts ForgetPromise.forget`

*

`$3`

`ts static timeoutHandler( time, config, externalStackTrace?): void;`

`$3`

#### time

number

#### config

#### externalStackTrace?

string

`$3`

void

`$3`

`ts ForgetPromise.timeoutHandler`

### IdLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Implements`

- Logger

`Constructors`

`$3`

`ts new IdLogger(logger, id?): IdLogger;`

`$3`

#### logger

#### id?

() => string

`$3`

IdLogger

`Accessors`

`$3`

`ts set id(id): void;`

#### Parameters

##### id

string

#### Returns

void

`Methods`

`$3`

`ts debug(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.debug`

*

`$3`

`ts error(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.error`

*

`$3`

`ts info(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.info`

*

`$3`

`ts log(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.log`

*

`$3`

`ts trace(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.trace`

*

`$3`

`ts warn(...data): void;`

`$3`

#### data

...unknown[]

`$3`

void

`$3`

`ts Logger.warn`

### IsObjectFactory

*

`Type Parameters`

`$3`

T extends TypedObject

`Constructors`

`$3`

`ts new IsObjectFactory(): IsObjectFactory;`

`$3`

IsObjectFactory\<T\>

`Methods`

`$3`

`ts create(shape?, additionalChecks?): TypeCheck;`

`$3`

#### shape?

ObjectTypeShape

#### additionalChecks?

TypeCheck\<TypedObject\>[]

`$3`

TypeCheck\<T\>

### LevelLogger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Extended by`

- ConsoleLogger

`Implements`

- Logger

`Constructors`

`$3`

`ts new LevelLogger(logger, level?): LevelLogger;`

`$3`

#### logger

#### level?

`$3`

LevelLogger

`Properties`

`$3`

`ts readonly level: LogLevelValue;`

*

`$3`

`ts readonly logger: Logger;`

`Accessors`

`$3`

`ts get debug(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get error(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get info(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get log(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get trace(): LogFunction;`

#### Returns

`$3`

*

`$3`

`ts get warn(): LogFunction;`

#### Returns

`$3`

### Log

*

`Deprecated`

use @xylabs/logger instead

`Constructors`

`$3`

`ts new Log(config): Log;`

`$3`

#### config

LogConfig

`$3`

Log

`Properties`

`$3`

`ts protected config: LogConfig;`

`Methods`

`$3`

`ts debug(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts error(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts info(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts log(...params): void;`

`$3`

#### params

...any[]

`$3`

void

*

`$3`

`ts warn(...params): void;`

`$3`

#### params

...any[]

`$3`

void

### ObjectWrapper

*

`Extended by`

- ValidatorBase

`Type Parameters`

`$3`

T extends EmptyObject = EmptyObject

`Constructors`

`$3`

`ts new ObjectWrapper(obj): ObjectWrapper;`

`$3`

#### obj

`$3`

ObjectWrapper\<T\>

`Properties`

`$3`

`ts readonly obj: T;`

`Accessors`

`$3`

`ts get protected stringKeyObj(): StringKeyObject;`

#### Returns

### PromiseEx

*

`Extends`

- Promise\<T\>

`Type Parameters`

`$3`

V = void

`Constructors`

`$3`

`ts new PromiseEx(func, value?): PromiseEx;`

`$3`

#### func

PromiseExFunc\<T\>

#### value?

`$3`

PromiseEx\<T, V\>

`$3`

`ts Promise.constructor`

`Properties`

`$3`

`ts optional cancelled: boolean;`

`Methods`

`$3`

`ts then( onfulfilled?, onrejected?, onvalue?): Promise;`

Attaches callbacks for the resolution and/or rejection of the Promise.

`$3`

#### TResult1

TResult1 = T

#### TResult2

TResult2 = never

`$3`

#### onfulfilled?

The callback to execute when the Promise is resolved.

null | (value) => TResult1 \| PromiseLike\<TResult1\>

#### onrejected?

The callback to execute when the Promise is rejected.

null | (reason) => TResult2 \| PromiseLike\<TResult2\>

#### onvalue?

(value?) => boolean

`$3`

Promise\<TResult1 \| TResult2\>

A Promise for the completion of which ever callback is executed.

`$3`

`ts Promise.then`

*

`$3`

`ts value(onvalue?): this;`

`$3`

#### onvalue?

(value?) => boolean

`$3`

this

### SilentLogger

*

`Implements`

- Logger

`Constructors`

`$3`

`ts new SilentLogger(): SilentLogger;`

`$3`

SilentLogger

`Properties`

`$3`

`ts readonly debug: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly error: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly info: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly log: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly trace: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

*

`$3`

`ts readonly warn: (..._data) => undefined;`

`$3`

#### \_data

...unknown[]

`$3`

undefined

`$3`

### ValidatorBase

*

`Extends`

- ObjectWrapper\<Partial\<T\>\>

`Type Parameters`

`$3`

T extends EmptyObject = AnyObject

`Implements`

- Validator\<T\>

`Constructors`

`$3`

`ts new ValidatorBase(obj): ValidatorBase;`

`$3`

#### obj

`$3`

ValidatorBase\<T\>

`$3`

ObjectWrapper.constructor

`Properties`

`$3`

`ts readonly obj: T;`

`$3`

ObjectWrapper.obj

`Accessors`

`$3`

`ts get protected stringKeyObj(): StringKeyObject;`

#### Returns

`$3`

ObjectWrapper.stringKeyObj

`Methods`

`$3`

`ts abstract validate(payload): Promisable;`

`$3`

#### payload

`$3`

Promisable\<Error[]\>

`$3`

Validator.validate

`$3`

### asAddress

*

`Call Signature`

`ts function asAddress(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asAddress(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### asHash

*

`Call Signature`

`ts function asHash(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asHash(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### asHex

*

`Call Signature`

`ts function asHex(value): undefined | Lowercase;`

`$3`

unknown

`$3`

undefined \| Lowercase\<string\>

`Call Signature`

`ts function asHex(value, assert): Lowercase;`

`$3`

unknown

`$3`

AssertConfig

`$3`

Lowercase\<string\>

### assertDefinedEx

*

`Call Signature`

`ts function assertDefinedEx(expr, messageFunc?): T;`

Intended for defined checks for variables

`$3`

Expression to be evaluated for truthiness

undefined | T

`$3`

AssertExMessageFunc\<T\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertDefinedEx(expr, errorFunc?): T;`

Intended for defined checks for variables

`$3`

R extends Error

`$3`

Expression to be evaluated for truthiness

undefined | T

`$3`

AssertExErrorFunc\<T, R\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertDefinedEx(expr): T;`

`$3`

undefined | T

`$3`

- passing a message will soon be required

`Call Signature`

`ts function assertDefinedEx(expr, message?): T;`

`$3`

undefined | T

`$3`

string

`$3`

- replace string with () => string

### assertEx

*

`Call Signature`

`ts function assertEx(expr, messageFunc?): T;`

Intended for simple truthiness checks for variables

`$3`

Expression to be evaluated for truthiness

undefined | null | T

`$3`

AssertExMessageFunc\<T\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertEx(expr, errorFunc?): T;`

Intended for simple truthiness checks for variables

`$3`

R extends Error

`$3`

Expression to be evaluated for truthiness

undefined | null | T

`$3`

AssertExErrorFunc\<T, R\>

`$3`

Value of expression

`$3`

AssertExError

`Call Signature`

`ts function assertEx(expr): T;`

`$3`

undefined | null | T

`$3`

- passing a message will soon be required

`Call Signature`

`ts function assertEx(expr, message?): T;`

`$3`

undefined | null | T

`$3`

string

`$3`

- replace string with () => string

### createDeepMerge

*

`ts function createDeepMerge(options): (...objects) => MergeAll;`

Creates a deep merge function with the specified options.

`Parameters`

`$3`

MergeOptions

Options for merging.

`Returns`

A deep merge function configured for the specified options.

`ts (...objects): MergeAll;`

`$3`

T extends AnyObject[]

`$3`

...T

`$3`

MergeAll\<T\>

### hexToBigInt

*

`ts function hexToBigInt(hex): bigint;`

`Parameters`

`$3`

Lowercase\<string\>

`Returns`

bigint

### staticImplements

*

`ts function staticImplements(): (constructor) => void;`

Annotation to decorate classes which implement static methods

`Type Parameters`

`$3`

`Returns`

The decorated class requiring it to implement the members of the the type as static properties/methods

`ts (constructor): void;`

`$3`

void

### toPromise

*

`ts function toPromise(value): Promise;`

`Type Parameters`

`$3`

`Parameters`

`$3`

Promisable\<T\>

`Returns`

Promise\<T\>

`$3`

### ApiConfig

*

`Properties`

`$3`

`ts apiDomain: string;`

*

`$3`

`ts optional apiKey: string;`

*

`$3`

`ts optional jwtToken: string;`

*

`$3`

`ts optional userid: string;`

### ForgetNodeConfig

*

`Extends`

- ForgetConfig\<T\>

`Type Parameters`

`$3`

T = any

`Properties`

`$3`

`ts optional name: string;`

`$3`

`ts ForgetConfig.name`

*

`$3`

`ts optional onCancel: () => void;`

`$3`

void

`$3`

`ts ForgetConfig.onCancel`

*

`$3`

`ts optional onComplete: (result) => void;`

`$3`

#### result

\[undefined \| T, undefined \| Error\]

`$3`

void

`$3`

`ts ForgetConfig.onComplete`

*

`$3`

`ts optional onException: (error) => void;`

`$3`

#### error

Error

`$3`

void

`$3`

`ts ForgetConfig.onException`

*

`$3`

`ts optional timeout: number;`

`$3`

`ts ForgetConfig.timeout`

*

`$3`

`ts optional terminateOnException: boolean;`

*

`$3`

`ts optional terminateOnTimeout: boolean;`

### HexConfig

*

Configuration of validation and output format

`Properties`

`$3`

`ts optional bitLength: number;`

*

`$3`

`ts optional byteSize: number;`

*

`$3`

`ts optional prefix: boolean;`

### Logger

*

Interface to handle overlap between Winston &console with as much congruency as possible.

`Properties`

`$3`

`ts debug: LogFunction;`

*

`$3`

`ts error: LogFunction;`

*

`$3`

`ts info: LogFunction;`

*

`$3`

`ts log: LogFunction;`

*

`$3`

`ts trace: LogFunction;`

*

`$3`

`ts warn: LogFunction;`

### ObjectTypeConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

### PromiseType

*

`Properties`

`$3`

`ts then: () => unknown;`

`$3`

unknown

### RetryConfig

*

`Extended by`

- RetryConfigWithComplete

`Properties`

`$3`

`ts optional backoff: number;`

*

`$3`

`ts optional interval: number;`

*

`$3`

`ts optional retries: number;`

### RetryConfigWithComplete

*

`Extends`

- RetryConfig

`Type Parameters`

`$3`

T = unknown

`Properties`

`$3`

`ts optional backoff: number;`

`$3`

RetryConfig.backoff

*

`$3`

`ts optional interval: number;`

`$3`

RetryConfig.interval

*

`$3`

`ts optional retries: number;`

`$3`

RetryConfig.retries

*

`$3`

`ts optional complete: (result?) => boolean;`

`$3`

#### result?

`$3`

boolean

### TypeCheckConfig

*

`Extended by`

- ObjectTypeConfig-TypeCheckRequiredConfig-TypeCheckOptionalConfig

`Properties`

`$3`

`ts optional log: boolean | Logger;`

### TypeCheckOptionalConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

*

`$3`

`ts required: false;`

### TypeCheckRequiredConfig

*

`Extends`

`Properties`

`$3`

`ts optional log: boolean | Logger;`

`$3`

*

`$3`

`ts required: true;`

### Validator

*

`Type Parameters`

`$3`

T extends EmptyObject = AnyObject

`Methods`

`$3`

`ts validate(payload): Promisable;`

`$3`

#### payload

`$3`

Promisable\<Error[]\>

`$3`

### Address

*

`ts type Address = Exclude;`

### AnyNonPromise

*

`ts type AnyNonPromise = Exclude;`

### AnyObject

*

`ts type AnyObject = Record;`

Any object, which means that it does not enforce the set of fields that it has. Extending from AnyObject will result in a type that includes the universal set of field names

### ApiStage

*

`ts type ApiStage = EnumValue;`

### AsOptionalTypeFunction

*

`ts type AsOptionalTypeFunction = (value) => undefined | TType;`

`Type Parameters`

`$3`

T extends AnyNonPromise = AnyNonPromise

`Type Parameters`

`$3`

TType extends AnyNonPromise

`Parameters`

`$3`

`Returns`

undefined \| TType

### AsTypeFunction

*

`Type Parameters`

`$3`

T extends AnyNonPromise = AnyNonPromise

`Call Signature`

`ts (value): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

undefined \| TType

`Call Signature`

`ts (value, config): TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

`$3`

TType

`Call Signature`

`ts (value, config): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

`$3`

undefined \| TType

`Call Signature`

`ts (value, assert): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

undefined \| TType

`Call Signature`

`ts ( value, assert, config): TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

`$3`

TType

`Call Signature`

`ts ( value, assert, config): undefined | TType;`

`$3`

TType extends AnyNonPromise

`$3`

`$3`

StringOrAlertFunction\<TType\>

`$3`

`$3`

undefined \| TType

### AssertExErrorFunc

*

`ts type AssertExErrorFunc = (value?) => R;`

`Type Parameters`

`$3`

R extends Error

`Parameters`

`$3`

T | null

`Returns`

### AssertExMessageFunc

*

`ts type AssertExMessageFunc = (value?) => string;`

`Type Parameters`

`$3`

`Parameters`

`$3`

T | null

`Returns`

string

### AsyncMutex

*

`ts type AsyncMutex = Promise;`

`Type Parameters`

`$3`

`Description`

Used to document promises that are being used as Mutexes

### Compare

*

`ts type Compare = (a, b) => number;`

`Type Parameters`

`$3`

`Parameters`

`$3`

`Returns`

number

### DeepOmitStartsWith

*

`Type Parameters`

`$3`

Prefix extends string

### DeepPickStartsWith

*

`Type Parameters`

`$3`

Prefix extends string

### DeepRestrictToStringKeys

*

`Type Parameters`

`$3`

### EmptyObject

*

`ts type EmptyObject = { [K in keyof T]?: never };`

An empty object, which means that it does enforce the set of field names, defaulting to an empty set until extended from, which then adds only those additional fields

`Type Parameters`

`$3`

T extends object = object

### EmptyObjectOf

*

`ts type EmptyObjectOf = EmptyObject extends T ? EmptyObject : never;`

`Type Parameters`

`$3`

T extends object

### Hash

*

`ts type Hash = Exclude;`

### HashBitLength

*

`ts type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;`

### Hex

*

`ts type Hex = Exclude, "reserved-hex-value">;`

### JsonArray

*

`ts type JsonArray = JsonValue[];`

### JsonObject

*

`ts type JsonObject = object;`

`Index Signature`

`ts [key: string]: JsonValue`

### JsonValue

*

### LogFunction

*

`ts type LogFunction = (...data) => void;`

`Parameters`

`$3`

...unknown[]

`Returns`

void

### LogLevel

*

`ts type LogLevel = LogLevelValue;`

`Deprecated`

Use LogLevelValueinstead. This name conflicts with theLogLevelenum and makes it confusing to import

### LogLevelKey

*

`ts type LogLevelKey = EnumKey;`

### LogLevelValue

*

`ts type LogLevelValue = EnumValue;`

### LogVerbosity

*

`ts type LogVerbosity = LogLevelKey;`

### NullablePromisable

*

`ts type NullablePromisable = Promisable;`

`Type Parameters`

`$3`

V = never

### NullablePromisableArray

*

`ts type NullablePromisableArray = PromisableArray;`

`Type Parameters`

`$3`

V = never

### OmitByPredicate

*

`ts type OmitByPredicate = (value, key) => boolean;`

`Type Parameters`

`$3`

T extends EmptyObject = Record\<string, unknown\>

`Parameters`

`$3`

T\[keyof T\]

`$3`

keyof T

`Returns`

boolean

### OmitStartsWith

*

`ts type OmitStartsWith = { [K in keyof T as K extends${Prefix}${string}? never : K]: T[K] };`

`Type Parameters`

`$3`

Prefix extends string

### Optional

*

`ts type Optional = Omit & Partial>;`

`Type Parameters`

`$3`

T extends object

`$3`

F extends keyof T

### OptionalPromisable

*

`ts type OptionalPromisable = Promisable;`

`Type Parameters`

`$3`

V = never

### OptionalPromisableArray

*

`ts type OptionalPromisableArray = PromisableArray;`

`Type Parameters`

`$3`

V = never

### Override

*

`ts type Override = Omit & T2;`

`Type Parameters`

`$3`

### PartialRecord

*

`ts type PartialRecord = { [P in K]?: T };`

`Type Parameters`

`$3`

K extends keyof any

`$3`

`Deprecated`

use Partial> instead

### PickByPredicate

*

`ts type PickByPredicate = (value, key) => boolean;`

`Type Parameters`

`$3`

T extends EmptyObject = Record\<string, unknown\>

`Parameters`

`$3`

T\[keyof T\]

`$3`

keyof T

`Returns`

boolean

### PickStartsWith

*

`ts type PickStartsWith = { [K in keyof T as K extends${Prefix}${string}? K : never]: T[K] };`

`Type Parameters`

`$3`

Prefix extends string

### Profiler

*

`ts type Profiler = Record;`

### Promisable

*

`ts type Promisable = PromiseEx | Promise | T;`

`Type Parameters`

`$3`

V = never

### PromisableArray

*

`ts type PromisableArray = Promisable;`

`Type Parameters`

`$3`

V = never

### PromiseExFunc

*

`ts type PromiseExFunc = (resolve?, reject?) => void;`

`Type Parameters`

`$3`

`Parameters`

`$3`

PromiseExSubFunc\<T, void\>

`$3`

PromiseExSubFunc\<T, void\>

`Returns`

void

### PromiseExSubFunc

*

`ts type PromiseExSubFunc = (value) => TResult;`

`Type Parameters`

`$3`

TResult = T

`Parameters`

`$3`

`Returns`

TResult

### PromiseExValueFunc

*

`ts type PromiseExValueFunc = (value?) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

`Returns`

boolean

### RawAxiosJsonRequestConfig

*

`ts type RawAxiosJsonRequestConfig = RawAxiosRequestConfig & object;`

`Type declaration`

`$3`

`ts optional compressLength: number;`

`Type Parameters`

`$3`

D = any

### RawAxiosJsonRequestUncompressedConfig

*

`ts type RawAxiosJsonRequestUncompressedConfig = RawAxiosRequestConfig;`

`Type Parameters`

`$3`

D = any

### StringKeyObject

*

`ts type StringKeyObject = object;`

`Type Parameters`

`$3`

T = unknown

`Index Signature`

`ts [key: string]: T`

### StringOrAlertFunction

*

`ts type StringOrAlertFunction = string | AssertExMessageFunc;`

`Type Parameters`

`$3`

T extends AnyNonPromise

### TypeCheck

*

`ts type TypeCheck = { (obj): obj is T; (obj, config): obj is T; (obj, config): obj is T; };`

`Type Parameters`

`$3`

T extends TypedValue

`Call Signature`

`ts (obj): obj is T;`

`$3`

`$3`

obj is T

`Call Signature`

`ts (obj, config): obj is T;`

`$3`

`$3`

TypeCheckConfig

`$3`

obj is T

`Call Signature`

`ts (obj, config): obj is T;`

`$3`

`$3`

undefined | number | TypeCheckConfig

`$3`

obj is T

### WithAdditional

*

`ts type WithAdditional = TAdditional extends EmptyObject ? T & TAdditional : T;`

`Type Parameters`

`$3`

T extends EmptyObject \| void

`$3`

TAdditional extends EmptyObject \| void = void

`$3`

### ApiStage

*

`ts const ApiStage: Enum<{ Beta: "beta"; Local: "local"; Prod: "prod"; }>;`

### AsObjectFactory

*

`ts const AsObjectFactory: object;`

`Type declaration`

`$3`

`ts create: (typeCheck) => AsTypeFunction;`

`$3`

#### T

T extends TypedObject

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

AsTypeFunction

`$3`

`ts createOptional: (typeCheck) => (value) => T | undefined;`

`$3`

#### T

T extends TypedObject

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

`ts (value): T | undefined;`

#### Parameters

##### value

#### Returns

T \| undefined

### AsTypeFactory

*

`ts const AsTypeFactory: object;`

`Type declaration`

`$3`

`ts create: (typeCheck) => AsTypeFunction;`

`$3`

#### T

T extends AnyNonPromise

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

AsTypeFunction\<T\>

`$3`

`ts createOptional: (typeCheck) => (value) => T | undefined;`

`$3`

#### T

T extends AnyNonPromise

`$3`

#### typeCheck

TypeCheck\<T\>

`$3`

`ts (value): T | undefined;`

#### Parameters

##### value

#### Returns

T \| undefined

### HashBitLength

*

`ts HashBitLength: HashBitLength[];`

### LogLevel

*

`ts const LogLevel: Enum<{ error: 1; warn: 2; info: 3; log: 4; debug: 5; trace: 6; }>;`

### NoOpLogFunction

*

`ts const NoOpLogFunction: (..._data) => undefined;`

`Parameters`

`$3`

...unknown[]

`Returns`

undefined

### ZERO_ADDRESS

*

`ts const ZERO_ADDRESS: Address;`

### ZERO_HASH

*

`ts const ZERO_HASH: Hash;`

### asAnyObject

*

`ts const asAnyObject: AsTypeFunction;`

### axios

*

`ts const axios: AxiosJson;`

### axiosUncompressed

*

`ts const axiosUncompressed: AxiosJsonUncompressed;`

### bitsToNibbles

*

`ts const bitsToNibbles: (value) => number;`

`Parameters`

`$3`

number

`Returns`

number

### clearTimeoutEx

*

`ts const clearTimeoutEx: (id) => void;`

`Parameters`

`$3`

string

`Returns`

void

### containsAll

*

`ts const containsAll: (source, target) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

`$3`

T[]

`Returns`

boolean

### createProfiler

*

`ts const createProfiler: () => Profiler;`

`Returns`

Profiler

### deepMerge

*

`ts const deepMerge: (...objects) => MergeAll;`

Deeply merges multiple objects into a new object.

`Type Parameters`

`$3`

T extends AnyObject[]

`Parameters`

`$3`

...T

`Returns`

MergeAll\<T\>

A new object with the merged properties.

### defaultForgetNodeConfig

*

`ts const defaultForgetNodeConfig: ForgetNodeConfig;`

### delay

*

`ts const delay: (ms) => Promise;`

`Parameters`

`$3`

number

`Returns`

Promise\<unknown\>

### difference

*

`ts const difference: (a, b) => Set;`

`Type Parameters`

`$3`

TKey

`Parameters`

`$3`

Set\<TKey\>

`$3`

Set\<TKey\>

`Returns`

Set\<TKey\>

### distinct

*

`ts const distinct: (value, index, array) => boolean;`

`Type Parameters`

`$3`

`Parameters`

`$3`

number

`$3`

T[]

`Returns`

boolean

### ellipsize

*

`ts const ellipsize: (value, length?) => string;`

`Parameters`

`$3`

string

`$3`

number

`Returns`

string

### exists

*

`ts const exists: (x?) => x is NonNullable;`

Used to type narrow an object which is possibly null or undefined. Works well with functional Array methods. For example:

`Type Parameters`

`$3`

`Parameters`

`$3`

The object which is potentially undefined or null

T | null

`Returns`

x is NonNullable

False if the object is null/undefined, true otherwise

`Example`

`ts const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []`

### filterAs

*

`ts const filterAs: (x, predicate) => NonNullable[];`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\>[]

### filterAsync

*

`ts const filterAsync: (array, predicate) => Promise;`

Returns the elements of an array that meet the condition specified in a callback function.

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

The array to filter.

`$3`

(value, index, array) => Promise\<boolean\>

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

`Returns`

Promise\<T[]\>

The elements of an array that meet the condition specified in a callback function.

### findAs

*

`ts const findAs: (x, predicate) => NonNullable | undefined;`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\> \| undefined

### findLastAs

*

`ts const findLastAs: (x, predicate) => NonNullable | undefined;`

`Type Parameters`

`$3`

Out

`Parameters`

`$3`

In[]

`$3`

(a) => Out

`Returns`

NonNullable\<Out\> \| undefined

### flatten

*

`ts const flatten: (a?, b?) => T[];`

`Type Parameters`

`$3`

`Parameters`

`$3`

T | ConcatArray\<T\>

`$3`

T | ConcatArray\<T\>

`Returns`

T[]

### forget

*

`ts const forget: (promise, config?) => void;`

`Type Parameters`

`$3`

`Parameters`

`$3`

Promisable\<T\>

`$3`

ForgetNodeConfig\<T\>

`Returns`

void

### fromFixedPoint

*

`ts const fromFixedPoint: (value, places?) => bigint;`

`Parameters`

`$3`

bigint

`$3`

number

`Returns`

bigint

### fulfilled

*

`ts const fulfilled: (val) => val is PromiseFulfilledResult;`

For use with Promise.allSettled to filter only successful results

`Type Parameters`

`$3`

`Parameters`

`$3`

PromiseSettledResult\<T\>

`Returns`

val is PromiseFulfilledResult

### fulfilledValues

*

`ts const fulfilledValues: (previousValue, currentValue) => T[];`

For use with Promise.allSettled to reduce to only successful result values

`Type Parameters`

`$3`

`Parameters`

`$3`

T[]

`$3`

PromiseSettledResult\<T\>

`Returns`

T[]

`Examples`

### functionName

*

`ts const functionName: (depth?) => string;`

`Parameters`

`$3`

number

`Returns`

string

### getApiStage

*

`ts const getApiStage: (hostname) => "beta" | "local" | "prod";`

`Parameters`

`$3`

string

`Returns`

"beta" \| "local" \| "prod"

### getFunctionName

*

`ts const getFunctionName: (depth?) => string;`

`Parameters`

`$3`

number

`Returns`

string

### handleError

*

`ts const handleError: (error, handler) => T;`

`Type Parameters`

`$3`

`Parameters`

`$3`

any

`$3`

(error) => T

`Returns`

### handleErrorAsync

*

`ts const handleErrorAsync: (error, handler) => Promise;`

`Type Parameters`

`$3`

`Parameters`

`$3`

any

`$3`

(error) => Promise\<T\>

`Returns`

Promise\<T\>

### hexFrom

*

`ts const hexFrom: (value, config?) => Hex;`

Takes unknown value and tries our best to convert it to a hex string

`Parameters`

`$3`

string | number | bigint | ArrayBufferLike

`$3`

`Returns`

### hexFromArrayBuffer

*

`ts const hexFromArrayBuffer: (buffer, config?) => Hex;`

Convert an ArrayBuffer to a hex string

`Parameters`

`$3`

ArrayBufferLike

`$3`

`Returns`

### hexFromBigInt

*

`ts const hexFromBigInt: (value, config?) => Hex;`

Convert a bigint to a hex string

`Parameters`

`$3`

bigint

`$3`

`Returns`

### hexFromHexString

*

`ts const hexFromHexString: (value, config?) => Hex;`

`Parameters`

`$3`

string

`$3`

`Returns`

### hexFromNumber

*

`ts const hexFromNumber: (value, config?) => Hex;`

`Parameters`

`$3`

number

`$3`

`Returns`

### hexRegex

*

`ts const hexRegex: RegExp;`

### hexRegexWithPrefix

*

`ts const hexRegexWithPrefix: RegExp;`

### intersection