UNPKG

path-to-prop

Version:

Retrieves a property from an object based on a 'path/to.that.prop'

19 lines (18 loc) 735 B
/** * Returns the keys of a path * * @param {string} path a/path/like.this * @returns {string[]} with keys */ export declare function getKeysFromPath(path: string | string[]): string[]; /** * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them * * @param {{ [key in string]: unknown }} obj an object to wherefrom to retrieve the deep reference of * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop'] * @returns {unknown} the last prop in the path */ export declare function pathToProp(obj: { [key in string]: unknown; }, path: string | string[]): unknown; export declare const getProp: typeof pathToProp;