@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.
Parameters
key Keycomposite CompositeReturns any
Returns value located at the given path or undefined otherwise.
Parameters
path Pathcomposite CompositeReturns any
Get own enumerable keys.
Parameters
composite CompositeReturns Array<Key>
Returns true if value located at given path is strictly equal to the one specified.
Parameters
path Pathvalue anycomposite CompositeReturns boolean
Returns true if key is included in composite's own enumerable ones, or false otherwise.
Parameters
key Keycomposite CompositeReturns boolean
Returns true if both composites have the same props or false otherwise.
Parameters
c1 Compositec2 CompositeReturns boolean
Returns a new composite with the result of having removed the property with the given key.
Parameters
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)
Parameters
path Pathcomposite CompositeReturns Composite
Returns a new composite with the result of having updated the property with the given key with the specified value.
Parameters
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)
Parameters
path Pathvalue anycomposite CompositeReturns Composite
Returns a new composite with the same own enumerable props of the one given.
Parameters
composite CReturns C
Returns true if both composites are of the same type (Array or Object) and their properties are strictly equal.
Parameters
c1 Compositec2 CompositeReturns boolean
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.
Parameters
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 12,707 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
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.