@stdlib/utils-any-own-by v0.1.0
anyOwnBy
Test whether at least one own property of a provided object passes a test implemented by a predicate function.
Installation
npm install @stdlib/utils-any-own-by
Usage
var anyOwnBy = require( '@stdlib/utils-any-own-by' );
anyBy( collection, predicate[, thisArg ] )
Tests whether at least one own property of a provided object
passes a test implemented by a predicate
function.
function isNegative( value ) {
return ( value < 0 );
}
var obj = {
'a': 1,
'b': 2,
'c': 3,
'd': -24,
'e': 12
};
var bool = anyOwnBy( obj, isNegative );
// returns true
If a predicate
function returns a truthy value, 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': -24,
'e': 12
};
var bool = anyOwnBy( obj, isPositive );
// returns true
The invoked function
is provided three arguments:
value
: property valuekey
: property keyobj
: input object
To set the function execution context, provide a thisArg
.
function verify( value ) {
this.sum += value;
this.count += 1;
return ( value > 0 );
}
var obj = {
'a': -1,
'b': -2,
'c': 3,
'd': -14
};
var context = {
'sum': 0,
'count': 0
};
var bool = anyOwnBy( obj, verify, context );
// returns true
var mean = context.sum / context.count;
// returns 0
Notes
If provided an empty object, the function returns
false
.function verify() { return true; } var bool = anyOwnBy( {}, verify ); // returns false
Examples
var randu = require( '@stdlib/random-base-randu' );
var anyOwnBy = require( '@stdlib/utils-any-own-by' );
function threshold( value ) {
return ( value > 0.94 );
}
var bool;
var obj = {};
var keys = [ 'a', 'b', 'c', 'd', 'e' ];
var i;
for ( i = 0; i < keys.length; i++ ) {
obj[ keys[ i ] ] = randu();
}
bool = anyOwnBy( obj, 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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
1 month ago