Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

Binary

Binary: (value: any, i: number) => boolean

Checks whether an iterated value passes a test.

param

iterated value

param

iteration index

returns

boolean indicating whether an iterated value passes a test

Type declaration

    • (value: any, i: number): boolean
    • Parameters

      • value: any
      • i: number

      Returns boolean

Nullary

Nullary: () => boolean

Checks whether an iterated value passes a test.

returns

boolean indicating whether an iterated value passes a test

Type declaration

    • (): boolean
    • Returns boolean

Predicate

Predicate: Nullary | Unary | Binary

Checks whether an iterated value passes a test.

param

iterated value

param

iteration index

returns

boolean indicating whether an iterated value passes a test

Unary

Unary: (value: any) => boolean

Checks whether an iterated value passes a test.

param

iterated value

returns

boolean indicating whether an iterated value passes a test

Type declaration

    • (value: any): boolean
    • Parameters

      • value: any

      Returns boolean

Functions

Export assignment iterEveryBy

  • Tests whether every iterated value passes a test implemented by a predicate function.

    Parameters

    • iterator: Iterator

      input iterator

    • predicate: Predicate

      predicate function

    • Optional thisArg: any

      execution context

    Returns boolean

    boolean indicating whether every iterated value passes a test implemented by a predicate function

    Example

    var array2iterator = require( `@stdlib/array/to-iterator` );
    
    function predicate( v ) {
        return ( v > 0 );
    }
    
    var it = array2iterator( [ 1, 1, 1, 1, 1 ] );
    
    var bool = iterEveryBy( it, predicate );
    // returns true