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

Export assignment arrayview2iterator

• arrayview2iterator(src: ArrayLike<any>, mapFcn?: MapFunction, thisArg?: any): Iterator
• arrayview2iterator(src: ArrayLike<any>, begin: number, mapFcn?: MapFunction, thisArg?: any): Iterator
• arrayview2iterator(src: ArrayLike<any>, begin: number, end: number, mapFcn?: MapFunction, thisArg?: any): Iterator

• Returns an iterator which iterates over each element in an array-like object view.

  Parameters

  • src: ArrayLike<any>

    input value

  • Optional mapFcn: MapFunction

    function to invoke for each iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  function fcn( v ) {
      return v * 10.0;
  }
  
  var iter = arrayview2iterator( [ 1, 2, 3, 4 ], fcn );
  
  var v = iter.next().value;
  // returns 10
  
  v = iter.next().value;
  // returns 20
  
  var bool = iter.next().done;
  // returns false

• Returns an iterator which iterates over each element in an array-like object view.

  Parameters

  • src: ArrayLike<any>

    input value

  • begin: number

    starting index (inclusive) (default: 0)

  • Optional mapFcn: MapFunction

    function to invoke for each iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var iter = arrayview2iterator( [ 1, 2, 3, 4 ], 1 );
  
  var v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 3
  
  var bool = iter.next().done;
  // returns false

• Returns an iterator which iterates over each element in an array-like object view.

  Parameters

  • src: ArrayLike<any>

    input value

  • begin: number

    starting index (inclusive) (default: 0)

  • end: number

    ending index (non-inclusive) (default: src.length)

  • Optional mapFcn: MapFunction

    function to invoke for each iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var iter = arrayview2iterator( [ 1, 2, 3, 4 ], 1, 3 );
  
  var v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 3
  
  var bool = iter.next().done;
  // returns true