Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "array/to-sparse-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 | Ternary

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

param

source array-like object

returns

iterator value

Nullary

Nullary: () => any

Map function invoked for each iterated value.

returns

iterator value

Type declaration

    • (): any
    • Returns any

Ternary

Ternary: (value: any, index: number, src: ArrayLike<any>) => any

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

param

source array-like object

returns

iterator value

Type declaration

    • (value: any, index: number, src: ArrayLike<any>): any
    • Parameters

      • value: any
      • index: number
      • src: ArrayLike<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 sparsearray2iterator

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

    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 = sparsearray2iterator( [ 1, , 3, 4 ] );
    
    var v = iter.next().value;
    // returns 1
    
    v = iter.next().value;
    // returns 3
    
    v = iter.next().value;
    // returns 4