External module "utils/deep-pluck/docs/types/index.d"

Export assignment deepPluck

• deepPluck(arr: Array<any>, path: Array<any> | string, options?: Options): Array<any>

• Extracts a nested property value from each element of an object array.

  Notes

  • If a key path does not exist, the function sets the plucked value as undefined.
  • Extracted values are not cloned.

  Parameters

  • arr: Array<any>

    source array

  • path: Array<any> | string

    key path

  • Optional options: Options

    function options

  Returns Array < any >

  destination array

  Example

  var arr = [
      {'a':{'b':{'c':1}}},
      {'a':{'b':{'c':2}}}
  ];
  
  var out = deepPluck( arr, 'a.b.c' );
  // returns [ 1, 2 ]

  Example

  var arr = [
      {'a':[0,1,2]},
      {'a':[3,4,5]}
  ];
  
  var out = deepPluck( arr, ['a',1] );
  // returns [ 1, 4 ]

  Example

  var arr = [
      {'a':{'b':{'c':1}}},
      {'a':{'b':{'c':2}}}
  ];
  
  var out = deepPluck( arr, 'a.b.c', {'copy':false} );
  // returns [ 1, 2 ]
  
  var bool = ( arr[ 0 ] === out[ 0 ] );
  // returns true

  Example

  var arr = [
      {'a':{'b':{'c':1}}},
      {'a':{'b':{'c':2}}}
  ];
  
  var out = deepPluck( arr, 'a|b|c', {'sep':'|'} );
  // returns [ 1, 2 ]