https://github.com/stdlib-js/utils-bifurcate-in
Split an object's own and inherited property values into two groups according to a predicate function.
https://github.com/stdlib-js/utils-bifurcate-in
aggregate bifurcate bifurcation for-in group group-by groupby javascript node node-js nodejs obj object partition split stdlib util utilities utility utils
Last synced: about 1 month ago
JSON representation
Split an object's own and inherited property values into two groups according to a predicate function.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-bifurcate-in
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T16:41:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-26T01:44:16.000Z (about 1 year ago)
- Last Synced: 2025-11-23T15:03:14.472Z (7 months ago)
- Topics: aggregate, bifurcate, bifurcation, for-in, group, group-by, groupby, javascript, node, node-js, nodejs, obj, object, partition, split, stdlib, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.11 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
We 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.
The 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.
When 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.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# bifurcateIn
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Split an object's **own** and **inherited** property values into two groups according to a predicate function.
## Installation
```bash
npm install @stdlib/utils-bifurcate-in
```
Alternatively,
- 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]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- 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]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To 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.
## Usage
```javascript
var bifurcateIn = require( '@stdlib/utils-bifurcate-in' );
```
#### bifurcateIn( obj, \[options,] predicate )
Splits an object's **own** and **inherited** property values into two groups according to a `predicate` function, which specifies which group a value in the input `object` belongs to. If a `predicate` function returns a truthy value, a value belongs to the first group; otherwise, a value belongs to the second group.
```javascript
function predicate( v ) {
return v[ 0 ] === 'b';
}
function Foo() {
this.a = 'beep';
this.b = 'boop';
return this;
}
Foo.prototype = Object.create( null );
Foo.prototype.c = 'foo';
Foo.prototype.d = 'bar';
var obj = new Foo();
var out = bifurcateIn( obj, predicate );
// e.g., returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
```
A `predicate` function is provided two arguments:
- **value**: object value.
- **key**: object index.
```javascript
function predicate( v, k ) {
console.log( '%s: %s', k, v );
return v[ 0 ] === 'b';
}
function Foo() {
this.a = 'beep';
this.b = 'boop';
return this;
}
Foo.prototype = Object.create( null );
Foo.prototype.c = 'foo';
Foo.prototype.d = 'bar';
var obj = new Foo();
var out = bifurcateIn( obj, predicate );
// e.g., returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
```
The function accepts the following `options`:
- **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'`.
- **thisArg**: execution context.
By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`.
```javascript
function predicate( v ) {
return v[ 0 ] === 'b';
}
function Foo() {
this.a = 'beep';
this.b = 'boop';
return this;
}
Foo.prototype = Object.create( null );
Foo.prototype.c = 'foo';
Foo.prototype.d = 'bar';
var obj = new Foo();
var opts = {
'returns': 'keys'
};
var out = bifurcateIn( obj, opts, predicate );
// e.g., returns [ [ 'a', 'b', 'd' ], [ 'c' ] ]
```
To return key-value pairs, set the `returns` option to `'*'`.
```javascript
function predicate( v ) {
return v[ 0 ] === 'b';
}
function Foo() {
this.a = 'beep';
this.b = 'boop';
return this;
}
Foo.prototype = Object.create( null );
Foo.prototype.c = 'foo';
Foo.prototype.d = 'bar';
var obj = new Foo();
var opts = {
'returns': '*'
};
var out = bifurcateIn( obj, opts, predicate );
// e.g., returns [ [ [ 'a', 'beep' ], [ 'b', 'boop ], [ 'd', 'bar' ] ], [ [ 'c', 'foo' ] ] ]
```
To set the `predicate` execution context, provide a `thisArg`.
```javascript
function predicate( v ) {
this.count += 1;
return v[ 0 ] === 'b';
}
function Foo() {
this.a = 'beep';
this.b = 'boop';
return this;
}
Foo.prototype = Object.create( null );
Foo.prototype.c = 'foo';
Foo.prototype.d = 'bar';
var obj = new Foo();
var context = {
'count': 0
};
var opts = {
'thisArg': context
};
var out = bifurcateIn( obj, opts, predicate );
// e.g., returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
console.log( context.count );
// => 4
```
## Notes
- 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.
- Because iteration order is **not** guaranteed, result order is **not** guaranteed.
- The function determines the list of own **and** inherited 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.
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var fromCodePoint = require( '@stdlib/string-from-code-point' );
var bifurcateIn = require( '@stdlib/utils-bifurcate-in' );
var opts;
var key;
var obj;
var out;
var i;
function Foo() {
var key;
var i;
for ( i = 0; i < 50; i++ ) {
key = fromCodePoint( 147+i );
this[ key ] = randu();
}
return this;
}
Foo.prototype = Object.create( null );
for ( i = 0; i < 50; i++ ) {
key = fromCodePoint( 97+i );
Foo.prototype[ key ] = randu();
}
// Generate a random object:
obj = new Foo();
// Compute the groups...
function predicate( v ) {
return ( v < 0.5 );
}
opts = {
'returns': '*'
};
out = bifurcateIn( obj, opts, predicate );
console.log( out );
```
* * *
## See Also
- [`@stdlib/utils-bifurcate`][@stdlib/utils/bifurcate]: split values into two groups.
- [`@stdlib/utils-bifurcate-by`][@stdlib/utils/bifurcate-by]: split values into two groups according to a predicate function.
- [`@stdlib/utils-bifurcate-own`][@stdlib/utils/bifurcate-own]: split an object's own property values into two groups according to a predicate function.
- [`@stdlib/utils-group-in`][@stdlib/utils/group-in]: group an object's own and inherited property values according to an indicator function.
* * *
## Notice
This 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.
For 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].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-bifurcate-in.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-bifurcate-in
[test-image]: https://github.com/stdlib-js/utils-bifurcate-in/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-bifurcate-in/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-bifurcate-in/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-bifurcate-in?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-bifurcate-in/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-bifurcate-in/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-bifurcate-in/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-bifurcate-in/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-bifurcate-in/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-bifurcate-in/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-bifurcate-in/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-bifurcate-in/main/LICENSE
[ecma-262-for-in]: https://262.ecma-international.org/5.1/#sec-12.6.4
[@stdlib/utils/bifurcate]: https://github.com/stdlib-js/utils-bifurcate
[@stdlib/utils/bifurcate-by]: https://github.com/stdlib-js/utils-bifurcate-by
[@stdlib/utils/bifurcate-own]: https://github.com/stdlib-js/utils-bifurcate-own
[@stdlib/utils/group-in]: https://github.com/stdlib-js/utils-group-in