Object~extras Class
Augments Y.Object with the same higher-order functions that array-extras adds to Y.Array. Note that, unlike Y.Array, iteration order for objects is arbitrary, so be careful when applying non-commutative operations!
Item Index
Methods
evalGet
-
o -
s
Extracts a value from an object, given a string containing a valid JavaScript expression. In a browser, this uses eval(). In Adobe AIR, it parses the string, thereby restricting the syntax to only dot notation.
Parameters:
-
oObjectthe object from which to extract a value
-
sStringthe expression
Returns:
requested value
evalSet
-
o -
s -
v
Sets a value inside an object, given a string containing a valid JavaScript expression. In a browser, this uses eval(). In Adobe AIR, it parses the string, thereby restricting the syntax to only dot notation.
Parameters:
-
oObjectthe object in which to set a value
-
sStringthe expression
-
vMixedthe value to set
every
-
o -
f -
c -
proto
Executes the supplied function on each item in the object. Iteration stops if the supplied function does not return a truthy value. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fFunctionthe function to execute on each item
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
true if every item in the array returns true from the supplied function, false otherwise
filter
-
o -
f -
c -
proto
Executes the supplied function on each item in the object. Returns a new object containing the items for which the supplied function returned a truthy value. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fFunctionthe function to execute on each item
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
object of items for which the supplied function returned a truthy value (empty if it never returned a truthy value)
find
-
o -
f -
c -
proto
Executes the supplied function on each item in the object, searching for the first item that matches the supplied function. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fFunctionthe function to execute on each item
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
the first item for which the supplied function returns true, or null if it never returns true
invoke
-
o -
f -
args
Executes a named method on each item in the object. Items that do not have a function by that name will be skipped.
Parameters:
-
oObjectthe object to iterate
-
fStringthe function to invoke
-
argsAny multipleany number of additional args are passed as parameters to the execution of the named method
Returns:
all return values, mapped according to the item key
keyOf
-
o -
v -
proto
Executes the supplied function on each item in the object, searching for the first item that matches the supplied function.
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
vMixedthe value to search for
-
protoBooleaninclude prototype properties
Returns:
key of an item strictly equal to v, or null if not found
map
-
o -
f -
c -
proto
Executes the supplied function on each item in the object and returns a new object with the results. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fStringthe function to invoke
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
all return values, mapped according to the item key
partition
-
o -
f -
c -
proto
Partitions an object into two new objects, one with the items for which the supplied function returns true, and one with the items for which the function returns false. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fFunctionthe function to execute on each item
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
object with two properties: matches and rejects. Each is an object containing the items that were selected or rejected by the test function (or an empty object if none).
reduce
-
o -
init -
f -
c -
proto
Executes the supplied function on each item in the object, folding the object into a single value. The function receives the value returned by the previous iteration (or the initial value if this is the first iteration), the value being iterated, the key, and the object itself as parameters (in that order). The function must return the updated value.
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
initMixedthe initial value
-
fStringthe function to invoke
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
final result from iteratively applying the given function to each item in the object
reduceRight
-
o -
init -
f -
c -
proto
Executes the supplied function on each item in the object, starting at the end and folding the object into a single value. The function receives the value returned by the previous iteration (or the initial value if this is the first iteration), the value being iterated, the key, and the object itself as parameters (in that order). The function must return the updated value.
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Since the order of iteration is undefined for objects, this is identical
to reduce.
Parameters:
-
oObjectthe object to iterate
-
initMixedthe initial value
-
fStringthe function to invoke
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
final result from iteratively applying the given function to each item in the object
reject
-
o -
f -
c -
proto
Executes the supplied function on each item in the object. Returns a new object containing the items for which the supplied function returned a falsey value. The function receives the value, the key, and the object itself as parameters (in that order).
By default, only properties owned by obj are enumerated. To include prototype properties, set the proto parameter to true.
Parameters:
-
oObjectthe object to iterate
-
fFunctionthe function to execute on each item
-
cObjectoptional context object
-
protoBooleaninclude prototype properties
Returns:
object of items for which the supplied function returned a falsey value (empty if it never returned a falsey value)
zip
-
a1 -
a2
Creates an object by pairing the corresponding elements of two arrays.
Parameters:
-
a1Arraythe keys which must be strings
-
a2Arraythe values
Returns:
object formed by pairing each element of the first array with an item in the second array having the corresponding index