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

Export assignment iterPipeline

• iterPipeline(iterFcn0: Function | Array<Function>, ...iterFcn: Array<Function>): PipelineFunction

• Returns an iterator pipeline.

  throws

  must provide at least one iterator function

  Parameters

  • iterFcn0: Function | Array<Function>

    iterator function or an array of iterator functions

  • Rest ...iterFcn: Array<Function>

  Returns PipelineFunction

  iterator pipeline

  Example

  var randu = require( `@stdlib/random/iter/randu` );
  var iterSomeBy = require( `@stdlib/iter/some-by` );
  var iterHead = require( `@stdlib/iter/head` );
  var iterThunk = require( `@stdlib/iter/pipeline-thunk` );
  
  function threshold( r ) {
      return ( r > 0.95 );
  }
  
  var it1 = iterThunk( iterHead, 100 );
  var it2 = iterThunk( iterSomeBy, 5, threshold );
  
  var p = iterPipeline( it1, it2 );
  
  var bool = p( randu() );
  // returns <boolean>