getIn()

Get the value starting at root and traversing the given path.

This function is valid in v2.23.0 to v2.24.3. This function has been downloaded 40 times.

Parameters

{*} root
The root object from which to start traversing path.
{Array} path
An array of names indicating the path under root that should be traversed.
{*=} opt_default Optional
The default value that will be returned if path cannot be fully traversed.

Returns

{*}
If the path cannot be fully traversed, opt_default will be returned. Otherwise the value found at path will be returned.

Required Function

This function directly requires the following function which is included automatically:

  • getAllIn()
    Get all of the values in root at each step of the given path.

Requiring Function

This function is directly required by the following function:

  • getAllIn()
    Get all of the values in root at each step of the given path.