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!

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

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

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>

---

See Also

• @stdlib/utils-any-by: test whether at least one element in a collection passes a test implemented by a predicate function.
• @stdlib/utils-every-by: test whether all elements in a collection pass a test implemented by a predicate function.
• @stdlib/utils-none-by: test whether all elements in a collection fail a test implemented by a predicate function.
• @stdlib/utils-async/some-by: test whether a collection contains n elements which pass a test implemented by a predicate function.
• @stdlib/utils-some-by-right: test whether a collection contains at least n elements which pass a test implemented by a predicate function, iterating from right to left.

---

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.