forOf()

Traverses all the characters in a string or all of the items in an array or an object, executing a function on each one.

This function is valid in v2.7.0 to v2.12.0. This function has been downloaded 13 times.

Parameters

{Array|Object|string} obj
If is an array, an array-like object, or an object, its items will be traversed. If it is a string its characters will be individual traversed.
{Function} fn
Function to call for each item traversed within obj. The parameters passed are as follows: (1) value, (2) key, (3) obj and (4) ender function. The this keyword will contain the number of times this fn function has been called. The ender function may be used to immediately stop traversing obj. Calling the ender function with a true-ish value will instead make the ender function return a boolean value indicating if the ender function has already been called (useful only in a catch or finally clause).
{boolean=} opt_traverseAll Optional, Default:false
Boolean indicating whether or not even the properties that are not owned by obj should be traversed. If true all properties will be traversed.

Returns

{number}
Number of times fn was called.

Required Functions

This function requires the following functions which are included automatically:

  • forIn()
    Runs through all of the properties of an object, executing a function for each property found.
  • isArrayLike()
    Determines if an object is an array or at least array-like.
  • forEach()
    Traverses all the characters in a string or all of the elements in an array or an array-like object, executing a function on each one.
  • typeOf()
    Either gets the type of a value or adds a constructor registering its custom type name.