External module "utils/do-while-each-right/docs/types/index.d"

Export assignment doWhileEachRight

• doWhileEachRight(collection: Collection, fcn: Callback, predicate: Predicate, thisArg?: any): Collection

• While a test condition is true, invokes a function once for each element in a collection, iterating from right to left.

  Notes

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

  • The condition is evaluated after executing the function to invoke; thus, the provided function always executes at least once.

  • When invoked, both the predicate function and the function to apply are provided three arguments:

    • value: collection value
    • index: collection index
    • collection: the input collection

  • If provided an empty collection, the function invokes the provided function with the collection index set to undefined.

  Parameters

  • collection: Collection

    input collection

  • fcn: Callback

    function to invoke

  • predicate: Predicate

    function which indicates whether to continue iterating over a collection

  • Optional thisArg: any

    execution context for the applied function

  Returns Collection

  input collection

  Example

  function predicate( v, index, collection ) {
      return ( v === v );
  }
  
  function log( v, index, collection ) {
      console.log( '%s: %d', index, v );
  }
  
  var arr = [ 1, NaN, 2, 3, 4, 5 ];
  
  doWhileEachRight( arr, log, predicate );