{"id":24063335,"url":"https://github.com/stdlib-js/utils-group-own","last_synced_at":"2025-04-23T16:28:07.644Z","repository":{"id":41427566,"uuid":"376892030","full_name":"stdlib-js/utils-group-own","owner":"stdlib-js","description":"Group an object's own property values according to an indicator function.","archived":false,"fork":false,"pushed_at":"2025-03-31T00:49:17.000Z","size":1181,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-23T16:28:06.220Z","etag":null,"topics":["aggregate","group","group-by","groupby","javascript","node","node-js","nodejs","obj","object","own","partition","split","stdlib","util","utilities","utility","utils"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-14T16:41:30.000Z","updated_at":"2025-03-31T00:38:12.000Z","dependencies_parsed_at":"2023-09-23T20:07:25.845Z","dependency_job_id":"581facb5-1c5b-4563-9285-1d44624f3edf","html_url":"https://github.com/stdlib-js/utils-group-own","commit_stats":{"total_commits":49,"total_committers":1,"mean_commits":49.0,"dds":0.0,"last_synced_commit":"89d5640394d22526f3a87b1d1a06ec3145753fe9"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-group-own","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-group-own/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-group-own/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-group-own/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/utils-group-own/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250470525,"owners_count":21435816,"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":["aggregate","group","group-by","groupby","javascript","node","node-js","nodejs","obj","object","own","partition","split","stdlib","util","utilities","utility","utils"],"created_at":"2025-01-09T09:37:27.722Z","updated_at":"2025-04-23T16:28:07.632Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# groupOwn\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Group an object's **own** property values according to an indicator function.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/utils-group-own\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar groupOwn = require( '@stdlib/utils-group-own' );\n```\n\n#### groupOwn( obj, \\[options,] indicator )\n\nGroups an object's **own** property values according to an `indicator` function, which specifies which group a value in the input `object` belongs to.\n\n```javascript\nfunction indicator( v ) {\n    return v[ 0 ];\n}\nvar obj = {\n    'a': 'beep',\n    'b': 'boop',\n    'c': 'foo',\n    'd': 'bar'\n};\n\nvar out = groupOwn( obj, indicator );\n// e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }\n```\n\nAn `indicator` function is provided two arguments:\n\n-   **value**: object value.\n-   **key**: object index.\n\n```javascript\nfunction indicator( v, k ) {\n    console.log( '%s: %s', k, v );\n    return v[ 0 ];\n}\nvar obj = {\n    'a': 'beep',\n    'b': 'boop',\n    'c': 'foo',\n    'd': 'bar'\n};\n\nvar out = groupOwn( obj, indicator );\n// e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }\n```\n\nThe function accepts the following `options`:\n\n-   **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`.\n-   **thisArg**: execution context.\n\nBy default, the function returns object values. To return object keys, set the `returns` option to `'keys'`.\n\n```javascript\nfunction indicator( v ) {\n    return v[ 0 ];\n}\nvar obj = {\n    'a': 'beep',\n    'b': 'boop',\n    'c': 'foo',\n    'd': 'bar'\n};\n\nvar opts = {\n    'returns': 'keys'\n};\nvar out = groupOwn( obj, opts, indicator );\n// e.g., returns { 'b': [ 'a', 'b', 'd' ], 'f': [ 'c' ] }\n```\n\nTo return key-value pairs, set the `returns` option to `'*'`.\n\n```javascript\nfunction indicator( v ) {\n    return v[ 0 ];\n}\nvar obj = {\n    'a': 'beep',\n    'b': 'boop',\n    'c': 'foo',\n    'd': 'bar'\n};\n\nvar opts = {\n    'returns': '*'\n};\nvar out = groupOwn( obj, opts, indicator );\n// e.g., returns { 'b': [ [ 'a', 'beep' ], [ 'b', 'boop ], [ 'd', 'bar' ] ], 'f': [ [ 'c', 'foo' ] ] }\n```\n\nTo set the `indicator` execution context, provide a `thisArg`.\n\n```javascript\nfunction indicator( v ) {\n    this.count += 1;\n    return v[ 0 ];\n}\nvar context = {\n    'count': 0\n};\nvar opts = {\n    'thisArg': context\n};\nvar obj = {\n    'a': 'beep',\n    'b': 'boop',\n    'c': 'foo',\n    'd': 'bar'\n};\nvar out = groupOwn( obj, opts, indicator );\n// e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }\n\nconsole.log( context.count );\n// =\u003e 4\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   Iteration order is **not** guaranteed, as `object` key enumeration is not specified according to the [ECMAScript specification][ecma-262-for-in]. In practice, however, most engines use insertion order to sort an `object`'s keys, thus allowing for deterministic iteration.\n\n-   Because iteration order is **not** guaranteed, result order is **not** guaranteed.\n\n-   The function determines the list of own enumerable properties **before** invoking the provided function. Hence, any modifications made to the input `object` **after** calling this function (such as adding and removing properties) will **not** affect the list of visited properties.\n\n-   The value returned by an `indicator` function should be a value which can be serialized as an `object` key. As a counterexample,\n\n    ```javascript\n    function indicator( v ) {\n        return {};\n    }\n    var obj = {\n        'a': 'beep',\n        'b': 'boop',\n        'c': 'foo',\n        'd': 'bar'\n    };\n    var out = groupOwn( obj, indicator );\n    // e.g., returns { '[object Object]': [ 'beep', 'boop', 'foo', 'bar' ] }\n    ```\n\n    while each group identifier is unique, all object values resolve to the same group because each group identifier serializes to the same `string`.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar randu = require( '@stdlib/random-base-randu' );\nvar fromCodePoint = require( '@stdlib/string-from-code-point' );\nvar groupOwn = require( '@stdlib/utils-group-own' );\n\nvar key;\nvar obj;\nvar out;\nvar i;\n\n// Generate a random object...\nobj = {};\nfor ( i = 0; i \u003c 100; i++ ) {\n    key = fromCodePoint( 97+i );\n    obj[ key ] = randu();\n}\n\nfunction indicator( v ) {\n    if ( v \u003c 0.5 ) {\n        return 'low';\n    }\n    return 'high';\n}\n\n// Compute the groups:\nout = groupOwn( obj, indicator );\nconsole.log( out );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-bifurcate-own`][@stdlib/utils/bifurcate-own]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003esplit an object's own property values into two groups according to a predicate function.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-group`][@stdlib/utils/group]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003egroup values as arrays associated with distinct keys.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-group-by`][@stdlib/utils/group-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003egroup values according to an indicator function.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-group-own.svg\n[npm-url]: https://npmjs.org/package/@stdlib/utils-group-own\n\n[test-image]: https://github.com/stdlib-js/utils-group-own/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/utils-group-own/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-group-own/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/utils-group-own?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/utils-group-own.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/utils-group-own/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/utils-group-own/tree/deno\n[deno-readme]: https://github.com/stdlib-js/utils-group-own/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/utils-group-own/tree/umd\n[umd-readme]: https://github.com/stdlib-js/utils-group-own/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/utils-group-own/tree/esm\n[esm-readme]: https://github.com/stdlib-js/utils-group-own/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/utils-group-own/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-group-own/main/LICENSE\n\n[ecma-262-for-in]: https://262.ecma-international.org/5.1/#sec-12.6.4\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/utils/bifurcate-own]: https://github.com/stdlib-js/utils-bifurcate-own\n\n[@stdlib/utils/group]: https://github.com/stdlib-js/utils-group\n\n[@stdlib/utils/group-by]: https://github.com/stdlib-js/utils-group-by\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Futils-group-own","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Futils-group-own","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Futils-group-own/lists"}