Module src/object/getArrayOfValuesFromNestedObject

Index

Functions

Functions

Const getArrayOfNestedPropertyValuesRecursively

getArrayOfNestedPropertyValuesRecursively(obj: Record<string, any>, nestedProperty: string, keyToFind: string[], targetPathArray?: PathArray): any[]

- Defined in src/object/getArrayOfValuesFromNestedObject/getArrayOfNestedPropertyValuesRecursively.ts:40
description

Collect values at path specified from nestable object (ex.invoice_lines) recursively and return results as array

example

getArrayOfNestedPropertyValuesRecursively({id: 1, nestable:{id: 2, key: 5, nestable:{id: 3}}]}, 'nestable', ['id', 'key']); // return [{ id: 2, key: 5 }, { id: 3 }]

getArrayOfNestedPropertyValuesRecursively({id: 1, nestable:{id: 2, object: { key: 1 } ]}, 'nestable', ['key'], 'object'); // return [{ key: 1 }]

getArrayOfNestedPropertyValuesRecursively( { nestable: [ {id: 1, nestable: [{id: 11}]}, {id: 2, nestable: [{id: 21}, {id: 11}]}, {id: 3}, {id: 4, nestable: [{id: 41, nestable: [{id: 441}]}]}, ] }, 'nestable', ['id'] ); // return [{ id: 1 }, { id: 11 },{ id: 2 }, { id: 21 }, { id: 11 }, { id: 3 }, { id: 4} , { id: 41 }, { id: 441 }]

Parameters
- obj: Record<string, any>
- nestedProperty: string
- keyToFind: string[]
- Default value targetPathArray: PathArray = []
Returns any[]

Const getArrayOfValuesFromNestedObject

getArrayOfValuesFromNestedObject<T>(obj: T, nestedObjectKey: string, keysToFind: string[], targetPath?: string): any[]

- Defined in src/object/getArrayOfValuesFromNestedObject/getArrayOfValuesFromNestedObject.ts:45
description

Get values at path specified from nestable object (ex.invoice_lines) as array

example

getArrayOfValuesFromNestedObject({nestable: {id: 1}}, 'nestable', ['id']); // return [{ id : 1 }]

getArrayOfValuesFromNestedObject({nestable: {target: {id : 2}}}, 'nestable', ['id'], 'target'); // return [{ id : 2 }]

getArrayOfValuesFromNestedObject({nestable: {target: {id : 2}}}, 'nestable', ['id'], 'target'); // return [{ id : 2 }]

getArrayOfValuesFromNestedObject({id: 1, nestable:{id: 2, nestable:{id: 3}}]}, 'nestable', ['id']); // return [{ id : 2 }, { id : 3 }]

getArrayOfValuesFromNestedObject( { nestable: [ {id: 1, nestable: [{id: 11}]}, {id: 2, nestable: [{id: 11}, {id: 21}, {id: 22}]}, {id: 3}, {id: 4, nestable: [{id: 41, nestable: [{id: 441}]}]}, ] }, 'nestable', ['id'] ); // return [{ id : 2 }, { id : 11 }, { id : 2 }, { id : 11 }, { id : 21 }, { id : 22 }, { id : 3 }, { id : 4 }, { id : 41 }, { id : 441 }]

Type parameters
- T: Record<string, any>
Parameters
- obj: T
- nestedObjectKey: string
  
  key of nestable object
- keysToFind: string[]
  
  array of keys to find at target path
- Default value targetPath: string = ""
  
  use this if you need to traverse a further than the target object
Returns any[]

{Array}

Generated using TypeDoc