External module "utils/every-by/docs/types/index.d"

Export assignment everyBy

• everyBy(collection: Collection, predicate: Predicate, thisArg?: any): boolean

• Tests whether all elements in a collection pass a test implemented by a predicate function.

  Notes

  • The predicate function is provided three arguments:

    • value: collection value
    • index: collection index
    • collection: the input collection

  • The function immediately returns upon encountering a non-truthy return value.

  • If provided an empty collection, the function returns true.

  Parameters

  • collection: Collection

    input collection

  • predicate: Predicate

    test function

  • Optional thisArg: any

    execution context

  Returns boolean

  boolean indicating whether all elements pass a test

  Example

  function isPositive( v ) {
      return ( v > 0 );
  }
  
  var arr = [ 1, 2, 3, 4 ];
  
  var bool = everyBy( arr, isPositive );
  // returns true