prop-value

prop-value

Simple path-to-value resolver.

import {resolveProp} from 'prop-value';

const obj = {
    first: {
        second: {
            value: 123
        }
    }
};

const value = resolveProp(obj, 'first.second.value');
//=> 123

Installing

$ npm i prop-value

Features

• It supports this to access an alternative/custom scope for resolution:

const obj = {value: 1};

const scope = {value: 2}; // custom/alternative 'this' scope

const value1 = resolveProp.call(scope, obj, 'value');
//=> 1 (default scope is used)

const value2 = resolveProp.call(scope, obj, 'this.value');
//=> 2 (custom 'this' scope is used)

const value3 = resolveProp.call(obj, obj, 'this.value');
//=> 1 (custom scope = default scope)

• Lower-level parseProp returns a parsing descriptor:

import {parseProp, IParseResult} from 'prop-value';

const obj = {first: {value: 123}};

const res: IParseResult = parseProp(obj, 'first.value');
//=> {chain: ['first', 'second'], idx: 1, value: 123}

Function parseProp supports custom this scope the same as resolveProp does. It will only throw an error if property getter/function throws an error.

• It supports functions-methods within resolution chain:

const obj = {
    first: {
        second() {
            // resolver correctly passes 'this' = first
            return this.value;
        },
        value: 123
    }
};

const value = resolveProp(obj, 'first.second');
//=> 123