1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
{{alias}}( obj, [options,] predicate )
Splits values into two groups according to a predicate function.
When invoked, the predicate function is provided two arguments:
- `value`: object value
- `key`: object key
If a predicate function returns a truthy value, a value is placed in the
first group; otherwise, a value is placed in the second group.
If provided an empty object, the function returns an empty array.
The function iterates over an object's own properties.
Key iteration order is *not* guaranteed, and, thus, result order is *not*
guaranteed.
Parameters
----------
obj: Object|Array|TypedArray
Input object to group.
options: Object (optional)
Options.
options.thisArg: any (optional)
Execution context.
options.returns: string (optional)
If `values`, values are returned; if `keys`, keys are returned; if `*`,
both keys and values are returned. Default: 'values'.
predicate: Function
Predicate function indicating which group a value in the input object
belongs to.
Returns
-------
out: Array<Array>|Array
Group results.
Examples
--------
> function predicate( v ) { return v[ 0 ] === 'b'; };
> var obj = { 'a': 'beep', 'b': 'boop', 'c': 'foo', 'd': 'bar' };
> var out = {{alias}}( obj, predicate )
[ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
// Output group results as keys:
> var opts = { 'returns': 'keys' };
> out = {{alias}}( obj, opts, predicate )
[ [ 'a', 'b', 'd' ], [ 'c' ] ]
// Output group results as key-value pairs:
> opts = { 'returns': '*' };
> out = {{alias}}( obj, opts, predicate )
[ [ ['a', 'beep'], ['b', 'boop'], ['d', 'bar'] ], [ ['c', 'foo' ] ] ]
See Also
--------
|
