External module "iter/some/docs/types/index.d"

Export assignment iterSome

• iterSome(iterator: Iterator, n: number): boolean

• Tests whether at least n iterated values are truthy.

  throws

  second argument must be a positive integer

  Parameters

  • iterator: Iterator

    input iterator

  • n: number

    minimum number of truthy elements

  Returns boolean

  boolean indicating whether at least n iterated values are truthy

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var it = array2iterator( [ 0, 0, 1, 1, 1 ] );
  
  var bool = iterSome( it, 3 );
  // returns true