- Gets an object containing value and search feedback info matching a property path.
- Recognizes negative array indexing.
Name: get-property
Install:
npm i -S @webkrafters/get-property
npm insall -save-dev @webkrafters/get-property
import getProperties from '@webkrafters/get-property';
const property = getProperties(data, path, defaultValue?); // => PropertyInfo| NAME | DESCRIPTION | TYPE | DEFAULT | |
|---|---|---|---|---|
| 1. | source | Data containing the property searched. | Any | N.A. |
| 2. | path |
Property path to search e.g.'friends.-3.name.last','friends.[-3].name.last',['friends', -3, 'name', 'last']Negative indexes are allowed. |
Integer String Symbol Array<Integer|String|Symbol> |
N.A. |
| 3. |
defaultValue [optional] |
Value property to return if data a tproperty path is either not found or null or undefined.
|
Any | Undefined |
| NAME | DESCRIPTION | TYPE | |
|---|---|---|---|
| 1. | _value |
Actual value found at the property path. It is undefined if none found.
|
Any |
| 2. | exists | True if property path found. | Boolean |
| 3. | index | Sanitized key corresponding to an index if the parent is an array and and the current key is alphanumeric integer. | Integer |
| 4. | isSelf |
True if property path is pointing at the source argument. This occurs when path argument is either undefined or an empty array.
|
Boolean |
| 5. | key |
The final key in the path argument list.
|
Integer String Symbol |
| 6. | source |
Reference to the node within the source argument containing the property data. Will be undefined if property was not found.
|
Array Object |
| 7. | trail | Property path segment representing the farthest valid property/sub property path found. | Array<Integer|String|Symbol> |
| 8. | value |
Value returned. May contain defaultValue if found value is either not found or null or undefined
|
Any |
MIT