Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

Binary

Binary<T, U>: (this: U, value: T, index: number) => T

Returns an updated collection element.

param

collection value

param

collection index

returns

updated element

Type parameters

  • T

  • U

Type declaration

    • (this: U, value: T, index: number): T
    • Parameters

      • this: U
      • value: T
      • index: number

      Returns T

Callback

Callback<T, U>: Nullary<T, U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>

Returns an updated collection element.

param

collection value

param

collection index

param

input collection

returns

updated element

Type parameters

  • T

  • U

Nullary

Nullary<T, U>: (this: U) => T

Returns an updated collection element.

returns

updated element

Type parameters

  • T

  • U

Type declaration

    • (this: U): T
    • Parameters

      • this: U

      Returns T

Ternary

Ternary<T, U>: (this: U, value: T, index: number, collection: Collection<T>) => T

Returns an updated collection element.

param

collection value

param

collection index

param

input collection

returns

updated element

Type parameters

  • T

  • U

Type declaration

    • (this: U, value: T, index: number, collection: Collection<T>): T
    • Parameters

      • this: U
      • value: T
      • index: number
      • collection: Collection<T>

      Returns T

Unary

Unary<T, U>: (this: U, value: T) => T

Returns an updated collection element.

param

collection value

returns

updated element

Type parameters

  • T

  • U

Type declaration

    • (this: U, value: T): T
    • Parameters

      • this: U
      • value: T

      Returns T

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.

    Type parameters

    • T

    • U

    Parameters

    • collection: Collection<T>

      input collection

    • fcn: Callback<T, U>

      function to invoke

    • Optional thisArg: ThisParameterType<Callback<T, U>>

      execution context

    Returns Collection < T >

    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