@jumpn/utils-composite
Advanced tools
Composite utilities (immutability, fp helpers)
NOTE: All the functions described in API are curried
$ npm install --save @jumpn/utils-composite
$ yarn add @jumpn/utils-composite
type Composite = Array<*> | Object;
type Key = number | string;
type Path = Array<Key>;
Get property value of given key.
key Keycomposite CompositeReturns any
Returns value located at the given path or undefined otherwise.
path Pathcomposite CompositeReturns any
Get own enumerable keys.
composite CompositeReturns Array<Key>
Returns true if value located at given path is deeply equal to the one specified.
path Pathvalue anycomposite CompositeReturns boolean
Returns true if key is included in composite's own enumerable ones, or false otherwise.
key Keycomposite CompositeReturns boolean
Returns true if both composites have the same props or false otherwise.
c1 Compositec2 CompositeReturns boolean
Returns true if parameter is a Composite or false otherwise
thing anyReturns true if composite has no own enumerable keys (is empty) or false otherwise
composite CompositeReturns boolean
Maps values of the given composite using mapper
mapper function (value: any, key: Key, composite: $Supertype<C>): anycomposite CReturns $Supertype<C>
Returns a new composite with the result of having removed the property with the given key.
key Keycomposite CompositeReturns Composite
Returns a new composite with the result of having removed the property located at the given path.
(This does the same as calling updateIn with updater:
() => updateIn.remove)
path Pathcomposite CompositeReturns Composite
Returns a new composite with the result of having updated the property with the given key with the specified value.
key Keyvalue anycomposite CompositeReturns Composite
Returns a new composite with the result of having updated the property located at the given path with the specified value.
(This does the same as calling updateIn with updater: () => value)
path Pathvalue anycomposite CompositeReturns Composite
Returns a new composite with the same own enumerable props of the one given.
composite CReturns C
Returns true if both composites are of the same type (Array or Object) and their properties are strictly equal.
c1 Compositec2 CompositeReturns boolean
Returns given composite if it has any own enumerable keys (is not empty) or undefined otherwise
composite CompositeReturns Composite
Returns a new composite with the result of having updated the property value at the given path with the result of the call to updater function.
Entry removal is supported by returning updateIn.remove symbol on updater
function.
path Pathupdater function (prev: any): anycomposite CompositeReturns Composite
MIT :copyright: Jumpn Limited / Mauro Titimoli (mauro@jumpn.com)
FAQs
Composite utilities (immutability, fp helpers)
The npm package @jumpn/utils-composite receives a total of 16,221 weekly downloads. As such, @jumpn/utils-composite popularity was classified as popular.
We found that @jumpn/utils-composite demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.