time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

deep_pluck.js (2734B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var deepGet = require( './../../deep-get' ).factory;
     24 var isArray = require( '@stdlib/assert/is-array' );
     25 var copy = require( './../../copy' );
     26 var defaults = require( './defaults.json' );
     27 var validate = require( './validate.js' );
     28 
     29 
     30 // MAIN //
     31 
     32 /**
     33 * Extracts a nested property value from each element of an object array.
     34 *
     35 * @param {Array} arr - source array
     36 * @param {(string|Array)} path - key path
     37 * @param {Options} [options] - function options
     38 * @param {boolean} [options.copy=true] - boolean indicating whether to return a new data structure
     39 * @param {string} [options.sep="."] - key path separator
     40 * @throws {TypeError} first argument must be an array
     41 * @throws {TypeError} options argument must be an object
     42 * @throws {TypeError} must provide valid options
     43 * @returns {Array} destination array
     44 *
     45 * @example
     46 * var arr = [
     47 *     {'a':{'b':{'c':1}}},
     48 *     {'a':{'b':{'c':2}}}
     49 * ];
     50 *
     51 * var out = deepPluck( arr, 'a.b.c' );
     52 * // returns [ 1, 2 ]
     53 *
     54 * @example
     55 * var arr = [
     56 *     {'a':[0,1,2]},
     57 *     {'a':[3,4,5]}
     58 * ];
     59 *
     60 * var out = deepPluck( arr, ['a',1] );
     61 * // returns [ 1, 4 ]
     62 *
     63 * @example
     64 * var arr = [
     65 *     {'a':{'b':{'c':1}}},
     66 *     {'a':{'b':{'c':2}}}
     67 * ];
     68 *
     69 * var out = deepPluck( arr, 'a.b.c', {'copy':false} );
     70 * // returns [ 1, 2 ]
     71 *
     72 * var bool = ( arr[ 0 ] === out[ 0 ] );
     73 * // returns true
     74 *
     75 * @example
     76 * var arr = [
     77 *     {'a':{'b':{'c':1}}},
     78 *     {'a':{'b':{'c':2}}}
     79 * ];
     80 *
     81 * var out = deepPluck( arr, 'a|b|c', {'sep':'|'} );
     82 * // returns [ 1, 2 ]
     83 */
     84 function deepPluck( arr, path, options ) {
     85 	var dget;
     86 	var opts;
     87 	var out;
     88 	var err;
     89 	var i;
     90 
     91 	if ( !isArray( arr ) ) {
     92 		throw new TypeError( 'invalid argument. First argument must be an array. Value: `' + arr + '`.' );
     93 	}
     94 	opts = copy( defaults );
     95 	if ( arguments.length > 2 ) {
     96 		err = validate( opts, options );
     97 		if ( err ) {
     98 			throw err;
     99 		}
    100 	}
    101 	if ( opts.copy ) {
    102 		out = new Array( arr.length );
    103 	} else {
    104 		out = arr;
    105 	}
    106 	dget = deepGet( path, {
    107 		'sep': opts.sep
    108 	});
    109 	for ( i = 0; i < arr.length; i++ ) {
    110 		out[ i ] = dget( arr[ i ] );
    111 	}
    112 	return out;
    113 }
    114 
    115 
    116 // EXPORTS //
    117 
    118 module.exports = deepPluck;