@stdlib/utils-bifurcate-in
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.5 • Public • Published

    bifurcateIn

    NPM version Build Status Coverage Status dependencies

    Split an object's own and inherited property values into two groups according to a predicate function.

    Installation

    npm install @stdlib/utils-bifurcate-in

    Usage

    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.

    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
    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'.

    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 '*'.

    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.

    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. 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

    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 );

    Notice

    This package is part of 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, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-bifurcate-in

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    11

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    60.2 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar