everyday-utils
Everyday utilities
npm i everyday-utils
|
pnpm add everyday-utils
|
yarn add everyday-utils
|
API
# EventEmitter
src/eventemitter.ts#L16
# off
(eventName, callback)
src/eventemitter.ts#L98
off<K>(eventName, callback) =>
- undefined | EventEmitter<E>
# on
(eventName, callback, options)
src/eventemitter.ts#L69 # MapFactory
src/everyday-utils.ts#L528
# constructor
({ ctor, entries })
src/everyday-utils.ts#L541
# new MapFactory
()
MapFactory<K, V>
# json
{
}
# delete
(keyA, keyB, value)
src/everyday-utils.ts#L510
# value
any
delete(keyA, keyB, value) =>
- boolean
# WeakMapFactory
src/everyday-utils.ts#L564
(fn) =>
- void
# Fluent
KeyedCache<T, U>(getter) =>
# filter
(key, value)
filter(key, value) =>
- boolean
accessors<S, T>(target, source, fn, filter) =>
# ()
() =>
- void
asyncFilter<T>(array, fn) =>
-
Promise<T []>
asyncSerialMap<T, U>(arr, fn) =>
-
Promise<U []>
asyncSerialReduce<T, U>(arr, fn, prev) =>
-
Promise<U>
# quiet
= false
boolean
attempt(x, quiet) =>
- void
# bindAll
(obj, target)
src/everyday-utils.ts#L587 chainSync(args) =>
# ()
() =>
- void
# chunk
(arr, size)
src/everyday-utils.ts#L13 # colorHash
(string, minColorHex)
src/everyday-utils.ts#L153 # colorOf
(id, sat, lum)
src/everyday-utils.ts#L163 # debugObjectMethods
(obj, ignoreKeys, { after, before }, name)
src/everyday-utils.ts#L630
# ignoreKeys
= []
string []
# name
= 'anonymous'
string
debugObjectMethods<T>(obj, ignoreKeys, { after, before }, name) =>
deepMutate(obj, walkFn) =>
- any
# defineProperty
(object, name, value)
src/everyday-utils.ts#L255 # entries
(obj)
src/everyday-utils.ts#L20 filterMap<T, U>(array, fn) =>
-
U []
# fromEntries
(entries)
src/everyday-utils.ts#L41 # getOwnProperty
(object, name)
src/everyday-utils.ts#L204 # getStringLength
(str)
src/everyday-utils.ts#L215
# str
string | number
getStringLength(str) =>
- number
# includesAny
(str, predicates)
src/everyday-utils.ts#L244 # keys
(obj)
src/everyday-utils.ts#L32 # luminate
(color, amount)
src/rgb.ts#L66 # memoize
(fn, map)
src/everyday-utils.ts#L302 # omit
(obj, props)
# padCenter
(str, length)
src/everyday-utils.ts#L208 # padEnd
(str, length, char)
src/everyday-utils.ts#L224 # padStart
(str, length, char)
src/everyday-utils.ts#L219 # pick
(obj, props)
# removeFromArray
(arr, el, quiet)
src/everyday-utils.ts#L172 # saturate
(color, amount)
src/rgb.ts#L86 # shallowEqualArray
(a, b)
src/everyday-utils.ts#L193 # sortCompare
(a, b)
src/everyday-utils.ts#L280 # sortCompareKeys
([ string, any ], [ string, any ])
src/everyday-utils.ts#L284 [ string, any ][ string, any ]
sortCompareKeys([ string, any ], [ string, any ]) =>
0
| 1
| -1
# sortObjectInPlace
(data)
src/everyday-utils.ts#L288
sortObjectInPlace<T extends Record<string, any>>(data) =>
# splitAt
(string, index)
src/everyday-utils.ts#L298 # styleToCss
(style)
src/everyday-utils.ts#L114
# style
CSSStyleDeclaration
styleToCss(style) =>
- string
toFluent<T extends Class<any>, C extends Fn<any, any>, S>(Schema, cb) =>
Credits
- deep-mutate-object by stagas – Deep traverse walk and mutate object keys and/or values.
- everyday-types by stagas – Everyday utility types
- pick-omit by stagas – The two missing object methods we always need.
- to-fluent by stagas – Convert a function with a settings object to fluent API.
Contributing
All contributions are welcome!