Test whether an object contains at least
nproperties which pass a test implemented by a predicate function.
var someInBy = require( '@stdlib/object/some-in-by' );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 trueOnce 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 trueThe 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-
If provided an empty
obj, the function returnsfalse.function alwaysTrue() { return true; } var bool = someInBy( {}, 1, alwaysTrue ); // returns false
-
The function does not skip
undefinedproperties.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).
var randu = require( '@stdlib/random/base/randu' );
var someInBy = require( '@stdlib/object/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>@stdlib/utils/any-in-by: test whether at least one property in an object passes a test implemented by a predicate function.@stdlib/object/every-in-by: test whether all properties (own and inherited) of an object pass a test implemented by a predicate function.@stdlib/utils/some-by: test whether a collection contains at leastnelements which pass a test implemented by a predicate function.@stdlib/utils/some-own-by: test whether someownproperties of a provided object satisfy a predicate function for at leastnproperties.