Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "array/from-iterator/docs/types/index.d"

Index

Type aliases

Binary

Binary: (value: any, index: number) => any

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

returns

iterator value

Type declaration

    • (value: any, index: number): any
    • Parameters

      • value: any
      • index: number

      Returns any

Iterator

Iterator: Iter | IterableIterator

MapFunction

MapFunction: Nullary | Unary | Binary

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

returns

iterator value

Nullary

Nullary: () => any

Map function invoked for each iterated value.

returns

iterator value

Type declaration

    • (): any
    • Returns any

Unary

Unary: (value: any) => any

Map function invoked for each iterated value.

param

iterated value

returns

iterator value

Type declaration

    • (value: any): any
    • Parameters

      • value: any

      Returns any

Functions

Export assignment iterator2array

  • Creates (or fills) an array from an iterator.

    Parameters

    • iterator: Iterator

      source iterator

    • Optional mapFcn: MapFunction

      function to invoke for each iterated value

    • Optional thisArg: any

      execution context

    Returns Array < any >

    output array

    Example

    var randu = require( `@stdlib/random/iter/randu` );
    
    var iter = randu({
        'iter': 10
    });
    
    var arr = iterator2array( iter );
    // returns <Array>
  • Creates (or fills) an array from an iterator.

    Parameters

    • iterator: Iterator

      source iterator

    • out: Collection

      output array

    • Optional mapFcn: MapFunction

      function to invoke for each iterated value

    • Optional thisArg: any

      execution context

    Returns Collection

    output array

    Example

    var Float64Array = require( `@stdlib/array/float64` );
    var randu = require( `@stdlib/random/iter/randu` );
    
    var iter = randu({
        'iter': 10
    });
    
    var out = new Float64Array( 10 );
    var arr = iterator2array( iter, out );
    // returns <Array>