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

Export assignment circarray2iterator

• circarray2iterator(src: ArrayLike<any>, mapFcn?: MapFunction, thisArg?: any): Iterator
• circarray2iterator(src: ArrayLike<any>, options: Options, mapFcn?: MapFunction, thisArg?: any): Iterator

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

  throws

  must provide valid options

  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

  var iter = circarray2iterator( [ 1, 2, 3, 4 ] );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 3
  
  // ...

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

  throws

  must provide valid options

  Parameters

  • src: ArrayLike<any>

    input value

  • options: Options

    function options

  • Optional mapFcn: MapFunction

    function to invoke for each iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var opts = {
      'dir': -1
  };
  var it = circarray2iterator( [ 1, 2, 3, 4 ], opts );
  // returns <Object>
  
  var v = it.next().value;
  // returns 4
  
  v = it.next().value;
  // returns 3
  
  v = it.next().value;
  // returns 2