Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/inmap-right/docs/types/index.d"

Index

Type aliases

Functions

Type aliases

Binary

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

Returns an updated collection element.

param

collection value

param

collection index

returns

updated element

Type declaration

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

      • value: any
      • index: number

      Returns any

Callback

Callback: Nullary | Unary | Binary | Ternary

Returns an updated collection element.

param

collection value

param

collection index

param

input collection

returns

updated element

Nullary

Nullary: () => any

Returns an updated collection element.

returns

updated element

Type declaration

    • (): any
    • Returns any

Ternary

Ternary: (value: any, index: number, collection: Collection) => any

Returns an updated collection element.

param

collection value

param

collection index

param

input collection

returns

updated element

Type declaration

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

      Returns any

Unary

Unary: (value: any) => any

Returns an updated collection element.

param

collection value

returns

updated element

Type declaration

    • (value: any): any
    • Parameters

      • value: any

      Returns any

Functions

Export assignment inmapRight

  • Invokes a function once for each element in a collection and updates the collection in-place, iterating from right to left.

    Notes

    • For dynamic array resizing, the only behavior made intentionally consistent with inmap (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for inmap(), [].push() behavior is consistent with inmapRight() [].unshift() behavior.

    Parameters

    • collection: Collection

      input collection

    • fcn: Callback

      function to invoke

    • Optional thisArg: any

      execution context

    Returns Collection

    input collection

    Example

    function scale( value, index, collection ) {
        console.log( '%s: %d', index, value );
        return value * index;
    }
    
    var arr = [ 1, 2, 3, 4 ];
    
    var out = inmapRight( arr, scale );
    // returns [ 0, 2, 6, 12 ]
    
    var bool = ( out === arr );
    // returns true