@exodus/basic-utils

Version: 0.0.0

Classes

ReadonlyMap

ReadonlySet

ReadonlyMap

ReadonlySet

ReadonlyMap

class

Constructor

constructor

ReadonlyMap(map: Map): ReadonlyMap

Parameters:

map: Map

Returns:

ReadonlyMap

Methods

[iterator]

[iterator](): IterableIterator

Returns:

IterableIterator

clear

clear(): never

Returns:

never

delete

delete(): never

Returns:

never

entries

entries(): IterableIterator

Returns:

IterableIterator

forEach

forEach(callbackfn: any): void

Parameters:

callbackfn: any

Returns:

void

get

get(key: K): undefined | V

Parameters:

key: K

Returns:

undefined | V

has

has(key: K): boolean

Parameters:

key: K

Returns:

boolean

keys

keys(): IterableIterator

Returns:

IterableIterator

set

set(): never

Returns:

never

values

values(): IterableIterator

Returns:

IterableIterator

Accessors

[toStringTag]

size

ReadonlySet

class

Constructor

constructor

ReadonlySet(set: Set): ReadonlySet

Parameters:

set: Set

Returns:

ReadonlySet

Methods

[iterator]

[iterator](): IterableIterator

Returns:

IterableIterator

add

add(): never

Returns:

never

clear

clear(): never

Returns:

never

delete

delete(): never

Returns:

never

entries

entries(): IterableIterator

Returns:

IterableIterator

forEach

forEach(callbackfn: any): void

Parameters:

callbackfn: any

Returns:

void

has

has(value: T): boolean

Parameters:

value: T

Returns:

boolean

keys

keys(): IterableIterator

Returns:

IterableIterator

values

values(): IterableIterator

Returns:

IterableIterator

Accessors

[toStringTag]

size

areSetsEqual

variable

Type

const areSetsEqual: (setA: Set, setB: Set) => boolean

Signature

__type(setA: Set, setB: Set): boolean

Parameters:

setA: Set

setB: Set

Returns:

boolean

defineProperty

variable

Type

const defineProperty: (obj: T, key: PropertyKey, value: unknown, descriptorOverrides: Partial) => T

Signature

__type(obj: T, key: PropertyKey, value: unknown, descriptorOverrides?: Partial): T

Parameters:

obj: T

key: PropertyKey

value: unknown

descriptorOverrides (optional): Partial

Returns:

difference

variable

Type

const difference: (a: any, b: any) => T[]

Signature

__type(a: any, b: any): T[]

Parameters:

a: any

b: any

Returns:

T[]

filterAsync

variable

Type

const filterAsync: (arr: T[], asyncFn: AsyncIteratee) => Promise

Signature

__type(arr: T[], asyncFn: AsyncIteratee): Promise

Parameters:

arr: T[]

asyncFn: AsyncIteratee

Returns:

Promise

intersection

variable

Type

const intersection: (a: any, b: any) => T[]

Signature

__type(a: any, b: any): T[]

Parameters:

a: any

b: any

Returns:

T[]

isNil

variable

Type

const isNil: (value: unknown) => value

Signature

__type(value: unknown): any

Parameters:

value: unknown

Returns:

any

isObjectLike

variable

Type

const isObjectLike: (value: unknown) => value

Signature

__type(value: unknown): any

Parameters:

value: unknown

Returns:

any

isPlainObject

variable

Type

const isPlainObject: (value: unknown) => value

Signature

__type(value: unknown): any

Parameters:

value: unknown

Returns:

any

keyBy

variable

Type

const keyBy: (arr: any, fnOrKey: any | { ... }) => Record

Signature

__type(arr: any, fnOrKey: any | any): Record

Parameters:

arr: any

fnOrKey: any | any

Returns:

Record

mapKeys

variable

Type

const mapKeys: (obj: T | null | undefined, fn: { ... }) => Record

Signature

__type(obj: T | null | undefined, fn: any): Record

Parameters:

obj: T | null | undefined

fn: any

Returns:

Record

mapValues

variable

Type

const mapValues: (obj: T | null | undefined, fn: { ... }) => Record

Signature

__type(obj: T | null | undefined, fn: any): Record

Parameters:

obj: T | null | undefined

fn: any

Returns:

Record

mapValuesAsync

variable

Type

const mapValuesAsync: (object: Record, asyncFn: AsyncMapIteratee) => Promise

Signature

__type(object: Record, asyncFn: AsyncMapIteratee): Promise

Parameters:

object: Record

asyncFn: AsyncMapIteratee

Returns:

Promise

omit

variable

Type

const omit: (obj: T | null | undefined, remove: any) => Omit

Signature

__type(obj: T | null | undefined, remove: any): Omit

Parameters:

obj: T | null | undefined

remove: any

Returns:

Omit

omitBy

variable

Type

const omitBy: (obj: T | null | undefined, predicate: { ... }) => Partial

Signature

__type(obj: T | null | undefined, predicate: any): Partial

Parameters:

obj: T | null | undefined

predicate: any

Returns:

Partial

orderBy

variable

Type

const orderBy: (arr: any, key: SortKey | SortKey[], order: SortOrder | SortOrder[]) => T[]

Signature

__type(arr: any, key?: SortKey | SortKey[], order?: SortOrder | SortOrder[]): T[]

Parameters:

arr: any

key (optional): SortKey | SortKey[]

order (optional): SortOrder | SortOrder[]

Returns:

T[]

partition

variable

Type

Partition

partitionAsync

variable

Type

const partitionAsync: (arr: T[], asyncFn: AsyncIteratee) => Promise

Signature

__type(arr: T[], asyncFn: AsyncIteratee): Promise

Parameters:

arr: T[]

asyncFn: AsyncIteratee

Returns:

Promise

pDebounce

variable

Type

const pDebounce: (fn: T, wait: number, options: DebounceOptions) => DebouncedFunction

Signature

__type(fn: T, wait: number, options?: DebounceOptions): DebouncedFunction

Parameters:

fn: T

wait: number

options (optional): DebounceOptions

Returns:

DebouncedFunction

pick

variable

Type

const pick: (obj: T | null | undefined, select: any) => Pick

Signature

__type(obj: T | null | undefined, select: any): Pick

Parameters:

obj: T | null | undefined

select: any

Returns:

Pick

pickBy

variable

Type

const pickBy: (obj: T | null | undefined, fn: { ... }) => Partial

Signature

__type(obj: T | null | undefined, fn: any): Partial

Parameters:

obj: T | null | undefined

fn: any

Returns:

Partial

restrictConcurrency

variable

Type

RestrictConcurrency

set

variable

Type

const set: (obj: T, path: Path, value: any) => T

Signature

__type(obj: T, path: Path, value: any): T

Parameters:

obj: T

path: Path

value: any

Returns:

cleanInput

function

Signature

cleanInput(value: string, decimals?: null | number): string

Parameters:

value: string

decimals (optional): null | number

Returns:

string

createEnum

function

Signature

createEnum(obj: T): EnumProxy

Parameters:

obj: T

Returns:

EnumProxy

deepPick

function

Signature

deepPick(obj: T, paths: Paths): DeepPickResult

Parameters:

obj: T

paths: Paths

Returns:

DeepPickResult

deepPick(obj: PlainObject, paths: any): PlainObject

Parameters:

obj: PlainObject

paths: any

Returns:

PlainObject

flattenToPaths

function

Signature

flattenToPaths(object: unknown): PathValue[]

Parameters:

object: unknown

Returns:

PathValue[]

getOwnProperty

function

Signature

getOwnProperty(object: T, key: K): undefined | any

Parameters:

object: T

key: K

Returns:

undefined | any

getOwnProperty(object: unknown, key: PropertyKey, expectedType: T): undefined | any

Parameters:

object: unknown

key: PropertyKey

expectedType: T

Returns:

undefined | any

getOwnProperty(object: unknown, key: PropertyKey): unknown

Parameters:

object: unknown

key: PropertyKey

Returns:

unknown

lazyFn

function

Signature

lazyFn(fnFactory: any): T

Parameters:

fnFactory: any

Returns:

memoize

function

Signature

memoize(func: TFunc, resolver?: TResolver, timeout?: number): MemoizedFunction

Parameters:

func: TFunc

resolver (optional): TResolver

timeout (optional): number

Returns:

MemoizedFunction

onceStrict

function

Signature

onceStrict(func: T): T

Parameters:

func: T

Returns:

shuffled

function

Signature

shuffled(input: any): T[]

Parameters:

input: any

Returns:

T[]

ReadonlyMap

class

Constructor

constructor

ReadonlyMap(map: Map): ReadonlyMap

Parameters:

map: Map

Returns:

ReadonlyMap

Methods

[iterator]

[iterator](): IterableIterator

Returns:

IterableIterator

clear

clear(): never

Returns:

never

delete

delete(): never

Returns:

never

entries

entries(): IterableIterator

Returns:

IterableIterator

forEach

forEach(callbackfn: any): void

Parameters:

callbackfn: any

Returns:

void

get

get(key: K): undefined | V

Parameters:

key: K

Returns:

undefined | V

has

has(key: K): boolean

Parameters:

key: K

Returns:

boolean

keys

keys(): IterableIterator

Returns:

IterableIterator

set

set(): never

Returns:

never

values

values(): IterableIterator

Returns:

IterableIterator

Accessors

[toStringTag]

size

ReadonlySet

class

Constructor

constructor

ReadonlySet(set: Set): ReadonlySet

Parameters:

set: Set

Returns:

ReadonlySet

Methods

[iterator]

[iterator](): IterableIterator

Returns:

IterableIterator

add

add(): never

Returns:

never

clear

clear(): never

Returns:

never

delete

delete(): never

Returns:

never

entries

entries(): IterableIterator

Returns:

IterableIterator

forEach

forEach(callbackfn: any): void

Parameters:

callbackfn: any

Returns:

void

has

has(value: T): boolean

Parameters:

value: T

Returns:

boolean

keys

keys(): IterableIterator

Returns:

IterableIterator

values

values(): IterableIterator

Returns:

IterableIterator

Accessors

[toStringTag]

size

partition

variable

Type

Partition

restrictConcurrency

variable

Type

RestrictConcurrency

areSetsEqual

function

Signature

areSetsEqual(setA: Set, setB: Set): boolean

Parameters:

setA: Set

setB: Set

Returns:

boolean

cleanInput

function

Signature

cleanInput(value: string, decimals: null | number): string

Parameters:

value: string

decimals: null | number

Returns:

string

createEnum

function

Signature

createEnum(obj: T): EnumProxy

Parameters:

obj: T

Returns:

EnumProxy

deepPick

function

Signature

deepPick(obj: T, paths: Paths): DeepPickResult

Parameters:

obj: T

paths: Paths

Returns:

DeepPickResult

deepPick(obj: PlainObject, paths: any): PlainObject

Parameters:

obj: PlainObject

paths: any

Returns:

PlainObject

defineProperty

function

Signature

defineProperty(obj: T, key: PropertyKey, value: unknown, descriptorOverrides: Partial): T

Parameters:

obj: T

key: PropertyKey

value: unknown

descriptorOverrides: Partial

Returns:

difference

function

Signature

difference(a: any, b: any): T[]

Parameters:

a: any

b: any

Returns:

T[]

filterAsync

function

Signature

filterAsync(arr: T[], asyncFn: AsyncIteratee): Promise

Parameters:

arr: T[]

asyncFn: AsyncIteratee

Returns:

Promise

flattenToPaths

function

Signature

flattenToPaths(object: unknown): PathValue[]

Parameters:

object: unknown

Returns:

PathValue[]

getOwnProperty

function

Signature

getOwnProperty(object: T, key: K): undefined | any

Audit friendly way to get object[key].

Parameters:

object: T

key: K

Returns:

undefined | any

getOwnProperty(object: unknown, key: PropertyKey, expectedType: T): undefined | any

Audit friendly way to get object[key].

Parameters:

object: unknown

key: PropertyKey

expectedType: T

Returns:

undefined | any

getOwnProperty(object: unknown, key: PropertyKey): unknown

Audit friendly way to get object[key].

Parameters:

object: unknown

key: PropertyKey

Returns:

unknown

intersection

function

Signature

intersection(a: any, b: any): T[]

Parameters:

a: any

b: any

Returns:

T[]

isNil

function

Signature

isNil(value: unknown): any

Parameters:

value: unknown

Returns:

any

isObjectLike

function

Signature

isObjectLike(value: unknown): any

Parameters:

value: unknown

Returns:

any

isPlainObject

function

Signature

isPlainObject(value: unknown): any

Parameters:

value: unknown

Returns:

any

keyBy

function

Signature

keyBy(arr: any, fnOrKey: any | any): Record

Parameters:

arr: any

fnOrKey: any | any

Returns:

Record

lazyFn

function

Signature

lazyFn(fnFactory: any): T

Parameters:

fnFactory: any

Returns:

mapKeys

function

Signature

mapKeys(obj: undefined | null | T, fn: any): Record

Parameters:

obj: undefined | null | T

fn: any

Returns:

Record

mapValues

function

Signature

mapValues(obj: undefined | null | T, fn: any): Record

Parameters:

obj: undefined | null | T

fn: any

Returns:

Record

mapValuesAsync

function

Signature

mapValuesAsync(object: Record, asyncFn: AsyncMapIteratee): Promise

Parameters:

object: Record

asyncFn: AsyncMapIteratee

Returns:

Promise

memoize

function

Signature

memoize(func: TFunc, resolver?: TResolver, timeout?: number): MemoizedFunction

Parameters:

func: TFunc

resolver (optional): TResolver

timeout (optional): number

Returns:

MemoizedFunction

omit

function

Signature

omit(obj: undefined | null | T, remove: any): Omit

Parameters:

obj: undefined | null | T

remove: any

Returns:

Omit

omitBy

function

Signature

omitBy(obj: undefined | null | T, predicate: any): Partial

Parameters:

obj: undefined | null | T

predicate: any

Returns:

Partial

onceStrict

function

Signature

onceStrict(func: T): T

Parameters:

func: T

Returns:

orderBy

function

Signature

orderBy(arr: any, key: SortKey | SortKey[], order: SortOrder | SortOrder[]): T[]

Parameters:

arr: any

key: SortKey | SortKey[]

order: SortOrder | SortOrder[]

Returns:

T[]

partitionAsync

function

Signature

partitionAsync(arr: T[], asyncFn: AsyncIteratee): Promise

Parameters:

arr: T[]

asyncFn: AsyncIteratee

Returns:

Promise

pDebounce

function

Signature

pDebounce(fn: T, wait: number, options: DebounceOptions): DebouncedFunction

Parameters:

fn: T

wait: number

options: DebounceOptions

Returns:

DebouncedFunction

Methods

promise

promise(function_: T): T

Parameters:

function_: T

Returns:

pick

function

Signature

pick(obj: undefined | null | T, select: any): Pick

Parameters:

obj: undefined | null | T

select: any

Returns:

Pick

pickBy

function

Signature

pickBy(obj: undefined | null | T, fn: any): Partial

Parameters:

obj: undefined | null | T

fn: any

Returns:

Partial

set

function

Signature

set(obj: T, path: Path, value: any): T

Parameters:

obj: T

path: Path

value: any

Returns:

shuffled

function

Signature

shuffled(input: any): T[]

Parameters:

input: any

Returns:

T[]

SynchronizedTime

variable

Type

const SynchronizedTime: {
  debug: { ... }
}

test

function

Signature

test(name: string, fn: any): void

Parameters:

name: string

fn: any

Returns:

void

test

function

Signature

test(name: string, cb: any): void

Parameters:

name: string

cb: any

Returns:

void

makeConcurrent

variable

Type

MakeConcurrent

@exodus/fusion-atoms @exodus/bip322-js

@exodus/basic-utils

Classes

Functions

Variables

ReadonlyMap

Constructor

Parameters:

Returns:

Methods

Returns:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Returns:

Returns:

Returns:

Accessors

ReadonlySet

Constructor

Parameters:

Returns:

Methods

Returns:

Returns:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Returns:

Returns:

Accessors

areSetsEqual

Type

Signature

Parameters:

Returns:

defineProperty

Type

Signature

Parameters:

Returns:

difference

Type

Signature

Parameters:

Returns:

filterAsync

Type

Signature

Parameters:

Returns:

intersection

Type

Signature

Parameters:

Returns:

isNil

Type

Signature

Parameters:

Returns:

isObjectLike

Type

Signature

Parameters:

Returns:

isPlainObject

Type

Signature

Parameters:

Returns: