{"id":21290121,"url":"https://github.com/jumpn/utils-composite","last_synced_at":"2025-07-11T14:32:11.409Z","repository":{"id":57103859,"uuid":"104276465","full_name":"jumpn/utils-composite","owner":"jumpn","description":"Composite Utilities","archived":false,"fork":false,"pushed_at":"2018-08-15T00:09:22.000Z","size":143,"stargazers_count":0,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-29T06:05:31.194Z","etag":null,"topics":["array","composite","functional-programming","immutability","object"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jumpn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-20T23:06:02.000Z","updated_at":"2018-08-15T00:09:23.000Z","dependencies_parsed_at":"2022-08-20T20:10:59.623Z","dependency_job_id":null,"html_url":"https://github.com/jumpn/utils-composite","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/jumpn/utils-composite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpn%2Futils-composite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpn%2Futils-composite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpn%2Futils-composite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpn%2Futils-composite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jumpn","download_url":"https://codeload.github.com/jumpn/utils-composite/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpn%2Futils-composite/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264833280,"owners_count":23670617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["array","composite","functional-programming","immutability","object"],"created_at":"2024-11-21T12:44:57.430Z","updated_at":"2025-07-11T14:32:11.061Z","avatar_url":"https://github.com/jumpn.png","language":"JavaScript","readme":"# @jumpn/utils-composite\n\n\u003e Composite utilities (immutability, fp helpers)\n\u003e\n\u003e **NOTE**: All the functions described in [API](#API) are curried\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\u003c!-- END doctoc --\u003e\n\n- [Installation](#installation)\n  - [Using npm](#using-npm)\n  - [Using yarn](#using-yarn)\n- [Types](#types)\n- [API](#api)\n  - [get](#get)\n    - [Parameters](#parameters)\n  - [getIn](#getin)\n    - [Parameters](#parameters-1)\n  - [getKeys](#getkeys)\n    - [Parameters](#parameters-2)\n  - [hasIn](#hasin)\n    - [Parameters](#parameters-3)\n  - [hasKey](#haskey)\n    - [Parameters](#parameters-4)\n  - [haveSameProps](#havesameprops)\n    - [Parameters](#parameters-5)\n  - [is](#is)\n    - [Parameters](#parameters-6)\n  - [isEmpty](#isempty)\n    - [Parameters](#parameters-7)\n  - [map](#map)\n    - [Parameters](#parameters-8)\n  - [remove](#remove)\n    - [Parameters](#parameters-9)\n  - [removeIn](#removein)\n    - [Parameters](#parameters-10)\n  - [set](#set)\n    - [Parameters](#parameters-11)\n  - [setIn](#setin)\n    - [Parameters](#parameters-12)\n  - [shallowCopy](#shallowcopy)\n    - [Parameters](#parameters-13)\n  - [shallowEqual](#shallowequal)\n    - [Parameters](#parameters-14)\n  - [toUndefinedIfEmpty](#toundefinedifempty)\n    - [Parameters](#parameters-15)\n  - [updateIn](#updatein)\n    - [Parameters](#parameters-16)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Installation\n\n### Using [npm](https://docs.npmjs.com/cli/npm)\n\n    $ npm install --save @jumpn/utils-composite\n\n### Using [yarn](https://yarnpkg.com)\n\n    $ yarn add @jumpn/utils-composite\n\n## Types\n\n```flowtype\ntype Composite = Array\u003c*\u003e | Object;\n\ntype Key = number | string;\n\ntype Path = Array\u003cKey\u003e;\n```\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### get\n\nGet property value of given key.\n\n#### Parameters\n\n-   `key` **Key** \n-   `composite` **Composite** \n\nReturns **any** \n\n### getIn\n\nReturns value located at the given path or undefined otherwise.\n\n#### Parameters\n\n-   `path` **Path** \n-   `composite` **Composite** \n\nReturns **any** \n\n### getKeys\n\nGet own enumerable keys.\n\n#### Parameters\n\n-   `composite` **Composite** \n\nReturns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;Key\u003e** \n\n### hasIn\n\nReturns true if value located at given path is deeply equal to the one\nspecified.\n\n#### Parameters\n\n-   `path` **Path** \n-   `value` **any** \n-   `composite` **Composite** \n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** \n\n### hasKey\n\nReturns true if key is included in composite's own enumerable ones,\nor false otherwise.\n\n#### Parameters\n\n-   `key` **Key** \n-   `composite` **Composite** \n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** \n\n### haveSameProps\n\nReturns true if both composites have the same props or false otherwise.\n\n#### Parameters\n\n-   `c1` **Composite** \n-   `c2` **Composite** \n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** \n\n### is\n\nReturns true if parameter is a Composite or false otherwise\n\n#### Parameters\n\n-   `thing` **any** \n\n### isEmpty\n\nReturns true if composite has no own enumerable keys (is empty) or false\notherwise\n\n#### Parameters\n\n-   `composite` **Composite** \n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** \n\n### map\n\nMaps values of the given composite using mapper\n\n#### Parameters\n\n-   `mapper` **function (value: any, key: Key, composite: $Supertype\u0026lt;C\u003e): any** \n-   `composite` **C** \n\nReturns **$Supertype\u0026lt;C\u003e** \n\n### remove\n\nReturns a new composite with the result of having removed the property with\nthe given key.\n\n#### Parameters\n\n-   `key` **Key** \n-   `composite` **Composite** \n\nReturns **Composite** \n\n### removeIn\n\nReturns a new composite with the result of having removed the property\nlocated at the given path.\n\n(This does the same as calling **updateIn** with updater:\n`() =\u003e updateIn.remove`)\n\n#### Parameters\n\n-   `path` **Path** \n-   `composite` **Composite** \n\nReturns **Composite** \n\n### set\n\nReturns a new composite with the result of having updated the property with\nthe given key with the specified value.\n\n#### Parameters\n\n-   `key` **Key** \n-   `value` **any** \n-   `composite` **Composite** \n\nReturns **Composite** \n\n### setIn\n\nReturns a new composite with the result of having updated the property\nlocated at the given path with the specified value.\n\n(This does the same as calling **updateIn** with updater: `() =\u003e value`)\n\n#### Parameters\n\n-   `path` **Path** \n-   `value` **any** \n-   `composite` **Composite** \n\nReturns **Composite** \n\n### shallowCopy\n\nReturns a new composite with the same own enumerable props of the one given.\n\n#### Parameters\n\n-   `composite` **C** \n\nReturns **C** \n\n### shallowEqual\n\nReturns true if both composites are of the same type (Array or Object) and\ntheir properties are strictly equal.\n\n#### Parameters\n\n-   `c1` **Composite** \n-   `c2` **Composite** \n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** \n\n### toUndefinedIfEmpty\n\nReturns given composite if it has any own enumerable keys (is not empty) or\nundefined otherwise\n\n#### Parameters\n\n-   `composite` **Composite** \n\nReturns **Composite** \n\n### updateIn\n\nReturns a new composite with the result of having updated the property value\nat the given path with the result of the call to updater function.\n\nEntry removal is supported by returning `updateIn.remove` symbol on updater\nfunction.\n\n#### Parameters\n\n-   `path` **Path** \n-   `updater` **function (prev: any): any** \n-   `composite` **Composite** \n\nReturns **Composite** \n\n## License\n\n[MIT](LICENSE.txt) :copyright: **Jumpn Limited** / Mauro Titimoli (mauro@jumpn.com)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjumpn%2Futils-composite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjumpn%2Futils-composite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjumpn%2Futils-composite/lists"}