everyday-utils

Everyday utilities

`npm i everyday-utils` `pnpm add everyday-utils` `yarn add everyday-utils`

API

<summary># EventEmitter </summary> src/eventemitter.ts#L16

<summary># constructor(data) </summary> src/eventemitter.ts#L37

<summary># new EventEmitter() </summary>

EventEmitter<E>

Partial<EventEmitter<any>>

<summary># listeners </summary> src/eventemitter.ts#L19

<summary># emit(eventName, args) </summary> src/eventemitter.ts#L46

<summary># eventName </summary>

Parameters<E [K]>

emit<K>(eventName, args) =>

EventEmitter

<summary># off(eventName, callback) </summary> src/eventemitter.ts#L98

<summary># eventName </summary>

<summary># callback </summary>

E [K]

off<K>(eventName, callback) =>

EventEmitter

<summary># on(eventName, callback, options) </summary> src/eventemitter.ts#L69

<summary># eventName </summary>

<summary># callback </summary>

E [K]

<summary># options </summary>

EventEmitterOptions

on<K>(eventName, callback, options) =>

Off

<summary># once(eventName, callback) </summary> src/eventemitter.ts#L122

<summary># eventName </summary>

<summary># callback </summary>

E [K]

once<K>(eventName, callback) =>

Off

<summary># MapFactory </summary> src/everyday-utils.ts#L528

<summary># constructor({ ctor, entries }) </summary> src/everyday-utils.ts#L541

<summary># new MapFactory() </summary>

MapFactory<K, V>

{

<summary># ctor </summary> src/everyday-utils.ts#L541

Class<V>

<summary># entries </summary> src/everyday-utils.ts#L541

readonly [ K, V ] []

<summary># new MapFactory() </summary>

MapFactory<K, V>

Class<V>

<summary># defaultData </summary>

Partial<V>

<summary># ctor </summary> src/everyday-utils.ts#L539

Class<V>

<summary># defaultArgs = [] </summary> src/everyday-utils.ts#L545

never []

<summary># get(key, args) </summary> src/everyday-utils.ts#L529

any []

get(key, args) =>

<summary># toJSON() </summary> src/everyday-utils.ts#L556

toJSON() =>

<summary># ctor = ... </summary> src/everyday-utils.ts#L559

Class<V>

<summary># entries = ... </summary> src/everyday-utils.ts#L558

[ K, V ] []

<summary># MapMap </summary> src/everyday-utils.ts#L459

<summary># constructor() </summary>

<summary># new MapMap() </summary>

MapMap<KA, KB, V>

<summary># clear() </summary> src/everyday-utils.ts#L485

clear() =>

void

<summary># delete(keyA, keyB) </summary> src/everyday-utils.ts#L477

delete(keyA, keyB) =>

boolean

<summary># get(keyA, keyB) </summary> src/everyday-utils.ts#L473

get(keyA, keyB) =>

<summary># has(keyA, keyB) </summary> src/everyday-utils.ts#L481

has(keyA, keyB) =>

boolean

<summary># set(keyA, keyB, value) </summary> src/everyday-utils.ts#L462

<summary># value </summary>

any

set(keyA, keyB, value) =>

number

<summary># MapMapSet </summary> src/everyday-utils.ts#L490

<summary># constructor() </summary>

<summary># new MapMapSet() </summary>

MapMapSet<KA, KB, V>

<summary># add(keyA, keyB, value) </summary> src/everyday-utils.ts#L493

<summary># value </summary>

any

add(keyA, keyB, value) =>

number

<summary># clear() </summary> src/everyday-utils.ts#L518

clear() =>

void

<summary># delete(keyA, keyB, value) </summary> src/everyday-utils.ts#L510

<summary># value </summary>

any

delete(keyA, keyB, value) =>

boolean

<summary># get(keyA, keyB) </summary> src/everyday-utils.ts#L506

get(keyA, keyB) =>

Set

<summary># has(keyA, keyB, value) </summary> src/everyday-utils.ts#L514

<summary># value </summary>

any

has(keyA, keyB, value) =>

boolean

<summary># MapSet </summary> src/everyday-utils.ts#L385

<summary># constructor() </summary>

<summary># new MapSet() </summary>

MapSet<K, V>

<summary># size </summary> src/everyday-utils.ts#L427

<summary># add(key, value) </summary> src/everyday-utils.ts#L388

<summary># value </summary>

any

add(key, value) =>

number

<summary># clear() </summary> src/everyday-utils.ts#L423

clear() =>

void

<summary># create(key) </summary> src/everyday-utils.ts#L399

create(key) =>

void

<summary># delete(key, value) </summary> src/everyday-utils.ts#L411

<summary># value </summary>

any

delete(key, value) =>

boolean

<summary># get(key) </summary> src/everyday-utils.ts#L407

get(key) =>

Set

<summary># has(key, value) </summary> src/everyday-utils.ts#L415

<summary># value </summary>

any

has(key, value) =>

boolean

<summary># hasKey(key) </summary> src/everyday-utils.ts#L419

hasKey(key) =>

boolean

<summary># values() </summary> src/everyday-utils.ts#L403

values() =>

<summary># WeakMapFactory </summary> src/everyday-utils.ts#L564

<summary># constructor(ctor, defaultArgs) </summary> src/everyday-utils.ts#L575

<summary># new WeakMapFactory() </summary>

WeakMapFactory<K, V>

Class<V>

<summary># defaultArgs = [] </summary>

never []

<summary># ctor </summary> src/everyday-utils.ts#L576

Class<V>

<summary># defaultArgs = [] </summary> src/everyday-utils.ts#L577

never []

<summary># get(key, args) </summary> src/everyday-utils.ts#L565

any []

get(key, args) =>

<summary># WeakMapSet </summary> src/everyday-utils.ts#L432

<summary># constructor() </summary>

<summary># new WeakMapSet() </summary>

WeakMapSet<K, V>

<summary># delete(key, value) </summary> src/everyday-utils.ts#L450

<summary># value </summary>

any

delete(key, value) =>

boolean

<summary># get(key) </summary> src/everyday-utils.ts#L446

get(key) =>

Set

<summary># has(key, value) </summary> src/everyday-utils.ts#L454

<summary># value </summary>

any

has(key, value) =>

boolean

<summary># set(key, value) </summary> src/everyday-utils.ts#L435

<summary># value </summary>

any

set(key, value) =>

number

<summary># Deferred </summary> src/everyday-utils.ts#L320

<summary># constructor() </summary>

<summary># error </summary> src/everyday-utils.ts#L317

Error

<summary># hasSettled </summary> src/everyday-utils.ts#L311

boolean

<summary># promise </summary> src/everyday-utils.ts#L312

Promise<T>

<summary># reject </summary> src/everyday-utils.ts#L315

<summary># (error) </summary>

<summary># error </summary>

Error

(error) =>

void

<summary># resolve </summary> src/everyday-utils.ts#L314

<summary># (value) </summary>

<summary># value </summary>

(value) =>

void

<summary># value </summary> src/everyday-utils.ts#L316

<summary># when </summary> src/everyday-utils.ts#L313

fn() =>

void

(fn) =>

void

<summary># Fluent </summary>

C & [K in keyof T ]-?: T [K] extends boolean ? Fluent<C, T> : Fn<[ T [K] ], Fluent<C, T>> & {

[K in keyof T ]-?: T [K] extends boolean ? Fluent<C, T> : never

<summary># ObjectFilterFn </summary>

<summary># (entry) </summary>

<summary># entry </summary>

[ string, unknown ]

(entry) =>

boolean

<summary># Off </summary> src/eventemitter.ts#L11

() =>

void

<summary># Promised </summary> src/everyday-utils.ts#L370

(args) =>

Promise

boolean

<summary># Deferred() </summary> src/everyday-utils.ts#L320

Deferred<T>() =>

Deferred

<summary># KeyedCache(getter) </summary> src/everyday-utils.ts#L356

<summary># getter(key, args) </summary>

string

getter(key, args) =>

Promise

KeyedCache<T, U>(getter) =>

string

(key, args) =>

Promise

<summary># accessors(target, source, fn, filter) </summary> src/everyday-utils.ts#L49

<summary># target </summary>

<summary># source </summary>

<summary># fn(key, value) </summary>

Narrow<keyof S, string>

<summary># value </summary>

S [Narrow<keyof S, string>]

fn(key, value) =>

PropertyDescriptor

<summary># filter(key, value) </summary>

Narrow<keyof S, string>

<summary># value </summary>

S [Narrow<keyof S, string>]

filter(key, value) =>

boolean

accessors<S, T>(target, source, fn, filter) =>

() =>

void

<summary># ansiColorFor(string) </summary> src/everyday-utils.ts#L167

<summary># string </summary>

string

ansiColorFor(string) =>

string

<summary># asyncFilter(array, fn) </summary> src/everyday-utils.ts#L248

<summary># array </summary>

T []

fn(item) =>

Promise

asyncFilter<T>(array, fn) =>

Promise

<summary># asyncSerialMap(arr, fn) </summary> src/everyday-utils.ts#L127

T []

<summary># fn(item, index, arr) </summary>

<summary># index </summary>

number

T []

fn(item, index, arr) =>

Promise

asyncSerialMap<T, U>(arr, fn) =>

Promise

<summary># asyncSerialReduce(arr, fn, prev) </summary> src/everyday-utils.ts#L136

T []

<summary># fn(prev, next, index, arr) </summary>

<summary># index </summary>

number

T []

fn(prev, next, index, arr) =>

Promise

asyncSerialReduce<T, U>(arr, fn, prev) =>

Promise

<summary># attempt(x, quiet) </summary> src/everyday-utils.ts#L700

x() =>

void

<summary># quiet = false </summary>

boolean

attempt(x, quiet) =>

void

<summary># bindAll(obj, target) </summary> src/everyday-utils.ts#L587

<summary># target = obj </summary>

T | U

bindAll<T, U>(obj, target) =>

<summary># chainSync(args) </summary> src/everyday-utils.ts#L182

() =>

any

chainSync(args) =>

() =>

void

<summary># cheapRandomId() </summary> src/everyday-utils.ts#L45

cheapRandomId() =>

string

<summary># checksum(str) </summary> src/everyday-utils.ts#L621

string

checksum(str) =>

number

<summary># chunk(arr, size) </summary> src/everyday-utils.ts#L13

T []

chunk<T, L>(arr, size) =>

Chunk

<summary># colorHash(string, minColorHex) </summary> src/everyday-utils.ts#L153

<summary># string </summary>

string

<summary># minColorHex = '888' </summary>

string

colorHash(string, minColorHex) =>

string

<summary># colorOf(id, sat, lum) </summary> src/everyday-utils.ts#L163

string

number

number

colorOf(id, sat, lum) =>

string

<summary># debugObjectMethods(obj, ignoreKeys, { after, before }, name) </summary> src/everyday-utils.ts#L630

<summary># ignoreKeys = [] </summary>

string []

<summary># hooks </summary>

{

<summary># after </summary> src/everyday-utils.ts#L632

<summary># (key, args, result) </summary>

string

any []

<summary># result </summary>

any

(key, args, result) =>

void

<summary># before </summary> src/everyday-utils.ts#L631

<summary># (key, args, stackErr) </summary>

string

any []

<summary># stackErr </summary>

Error

(key, args, stackErr) =>

void

<summary># name = 'anonymous' </summary>

string

debugObjectMethods<T>(obj, ignoreKeys, { after, before }, name) =>

<summary># deepMutate(obj, walkFn) </summary>

any

<summary># walkFn(key, value, holder) </summary>

string

<summary># value </summary>

any

<summary># holder </summary>

any

walkFn(key, value, holder) =>

[ string, any ]

deepMutate(obj, walkFn) =>

any

<summary># defineProperty(object, name, value) </summary> src/everyday-utils.ts#L255

<summary># object </summary>

object

PropertyKey

<summary># value </summary>

defineProperty<T>(object, name, value) =>

object

<summary># entries(obj) </summary> src/everyday-utils.ts#L20

entries<K, V, T>(obj) =>

entries<K, V, T extends ArrayLike<any, T>>(obj) =>

<summary># filter(obj, fn) </summary>

ObjectFilterFn

filter<T>(obj, fn) =>

Partial

<summary># filterMap(array, fn) </summary> src/everyday-utils.ts#L275

<summary># array </summary>

T [] | readonly T []

<summary># fn(item, index, array) </summary>

<summary># index </summary>

number

<summary># array </summary>

T [] | readonly T []

fn(item, index, array) =>

null

false

filterMap<T, U>(array, fn) =>

<summary># fromEntries(entries) </summary> src/everyday-utils.ts#L41

<summary># entries </summary>

readonly [ K, V ] []

fromEntries<K, V>(entries) =>

Record

<summary># getOwnProperty(object, name) </summary> src/everyday-utils.ts#L204

<details id="object$135" title="Par

Package detail

everyday-utils

readme

everyday-utils

`npm i everyday-utils` `pnpm add everyday-utils` `yarn add everyday-utils`

API

Package detail

readme

everyday-utils

npm i everyday-utils pnpm add everyday-utils yarn add everyday-utils

API

`npm i everyday-utils` `pnpm add everyday-utils` `yarn add everyday-utils`