88 lines
1.9 KiB
JavaScript
88 lines
1.9 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Group an object's own property values according to an indicator function.
|
||
|
|
*
|
||
|
|
* @module @stdlib/utils/group-own
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var groupOwn = require( '@stdlib/utils/group-own' );
|
||
|
|
*
|
||
|
|
* function indicator( v ) {
|
||
|
|
* return v[ 0 ];
|
||
|
|
* }
|
||
|
|
* var obj = {
|
||
|
|
* 'a': 'beep',
|
||
|
|
* 'b': 'boop',
|
||
|
|
* 'c': 'foo',
|
||
|
|
* 'd': 'bar'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* var out = groupOwn( obj, indicator );
|
||
|
|
* // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var groupOwn = require( '@stdlib/utils/group-own' );
|
||
|
|
*
|
||
|
|
* function indicator( v ) {
|
||
|
|
* return v[ 0 ];
|
||
|
|
* }
|
||
|
|
* var obj = {
|
||
|
|
* 'a': 'beep',
|
||
|
|
* 'b': 'boop',
|
||
|
|
* 'c': 'foo',
|
||
|
|
* 'd': 'bar'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* var opts = {
|
||
|
|
* 'returns': 'keys'
|
||
|
|
* };
|
||
|
|
* var out = groupOwn( obj, opts, indicator );
|
||
|
|
* // e.g., returns { 'b': [ 'a', 'b', 'd' ], 'f': [ 'c' ] }
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var groupOwn = require( '@stdlib/utils/group-own' );
|
||
|
|
*
|
||
|
|
* function indicator( v ) {
|
||
|
|
* return v[ 0 ];
|
||
|
|
* }
|
||
|
|
* var obj = {
|
||
|
|
* 'a': 'beep',
|
||
|
|
* 'b': 'boop',
|
||
|
|
* 'c': 'foo',
|
||
|
|
* 'd': 'bar'
|
||
|
|
* };
|
||
|
|
* var opts = {
|
||
|
|
* 'returns': '*'
|
||
|
|
* };
|
||
|
|
* var out = groupOwn( obj, opts, indicator );
|
||
|
|
* // e.g., returns { 'b': [ [ 'a', 'beep' ], [ 'b', 'boop' ], [ 'd', 'bar' ] ], 'f': [ [ 'c', 'foo' ] ] }
|
||
|
|
*/
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var groupOwn = require( './main.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = groupOwn;
|