File size: 2,574 Bytes
1e92f2d |
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 64 65 66 67 68 69 70 71 |
import flat from 'flat'
import { DELIMITER } from './constants.js'
import { selectParams } from './select-params.js'
import { FlattenParams, GetOptions } from './flat.types.js'
import { propertyKeyRegex } from './property-key-regex.js'
const TEMP_HOLDING_KEY = 'TEMP_HOLDING_KEY'
/**
* @load ./get.doc.md
* @memberof module:flat
* @param {FlattenParams} params flatten params from which property has to be taken
* @param {string} [propertyPath] name of the property
* @param {GetOptions} options options
* @returns {any} when property key exists directly it returns what is inside,
* otherwise it tries to find any nested objects and returns
* them
*/
const get = (params: FlattenParams = {}, propertyPath?: string, options?: GetOptions): any => {
if (!propertyPath) {
return flat.unflatten(params)
}
// when object has this key - simply return it
// we cannot rely on typeof params[propertyPath !== 'undefined' because params can actually be
// undefined and in such case if would pass and function would return [undefined]
if (Object.keys(params).find((key) => (key === propertyPath))) {
return params[propertyPath]
}
const regex = propertyKeyRegex(propertyPath, options)
const selectedParams = selectParams(params, propertyPath, options)
const nestedProperties = Object.keys(selectedParams).reduce((memo, key, index) => {
let newKey = key.replace(regex, `${TEMP_HOLDING_KEY}${DELIMITER}`)
// when user wants to take allSiblings we have to fix the indexes so nested items from
// different siblings don't overlap
//
// Example for key `nested.1.el`:
// 'nested.0.el.0.value': 'val0.0',
// 'nested.0.el.1.value': 'val0.1',
// 'nested.1.el.0.value': 'val1',
// 'nested.1.el.1.value': 'val2',
//
// has to be changed to:
// 'TEMP_HOLDING_KEY.0.value': 'val0.0',
// 'TEMP_HOLDING_KEY.1.value': 'val0.1',
// 'TEMP_HOLDING_KEY.2.value': 'val1',
// 'TEMP_HOLDING_KEY.3.value': 'val2',
if (options?.includeAllSiblings) {
newKey = newKey.replace(
new RegExp(`${TEMP_HOLDING_KEY}\\${DELIMITER}(\\d*)`),
`${TEMP_HOLDING_KEY}${DELIMITER}${index}`,
)
}
memo[newKey] = selectedParams[key]
return memo
}, {} as FlattenParams)
if (Object.keys(nestedProperties).length) {
return (flat.unflatten(nestedProperties) as Record<string, unknown>)[TEMP_HOLDING_KEY]
}
return undefined
}
export { get }
|