@stdlib/utils-some-in-by NPM

someInBy

Test whether an object contains at least n properties which pass a test implemented by a predicate function.

Installation

npm install @stdlib/utils-some-in-by

Usage

var someInBy = require( '@stdlib/utils-some-in-by' );

someInBy( obj, n, predicate[, thisArg ] )

Tests whether an obj contains at least n properties which pass a test implemented by a predicate function.

function isNegative( value ) {
    return ( value < 0 );
}

var obj = {
    'a': 1,
    'b': -2,
    'c': 3,
    'd': -1
};

var bool = someInBy( obj, 2, isNegative );
// returns true

Once the function finds n successful properties, the function immediately returns true.

function isPositive( value ) {
    if ( value < 0 ) {
        throw new Error( 'should never reach this line' );
    }
    return ( value > 0 );
}

var obj = {
    'a': 1,
    'b': 2,
    'c': -3,
    'd': 4
};

var bool = someInBy( obj, 2, isPositive );
// returns true

The invoked function is provided three arguments:

value: object property value
key: object property key
obj: input object

To set the function execution context, provide a thisArg.

function sum( value ) {
    this.sum += value;
    this.count += 1;
    return ( value < 0 );
}

var obj = {
    'a': 1,
    'b': 2,
    'c': 3,
    'd': -5
};

var context = {
    'sum': 0,
    'count': 0
};

var bool = someInBy( obj, 1, sum, context );
// returns true

var mean = context.sum / context.count;
// returns 0.25

Notes

If provided an empty obj, the function returns false.

function alwaysTrue() {
    return true;
}
var bool = someInBy( {}, 1, alwaysTrue );
// returns false

The function does not skip undefined properties.

function log( value, key ) {
    console.log( '%s: %s', key, value );
    return ( value < 0 );
}

var obj = {
    'a': 1,
    'b': void 0,
    'c': void 0,
    'd': 4,
    'e': -1
};

var bool = someInBy( obj, 1, log );
// logs
// a: 1
// b: void 0
// c: void 0
// d: 4
// e: -1

The function provides limited support for dynamic objects (i.e., objects whose properties change during execution).

Examples

var randu = require( '@stdlib/random-base-randu' );
var someInBy = require( '@stdlib/utils-some-in-by' );

function threshold( value ) {
    return ( value > 0.95 );
}

var bool;
var obj = {};
var i;

for ( i = 0; i < 100; i++ ) {
    obj[ 'key' + i ] = randu();
}

bool = someInBy( obj, 5, threshold );
// returns <boolean>

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.