pathval

What is pathval?

The pathval npm package is a utility for working with object paths. It allows you to get and set values on an object using a string path, which is useful for accessing deeply nested properties.

What are pathval's main functionalities?

Get value from object

This feature allows you to retrieve a value from a nested object using a string path.

{"const pathval = require('pathval');
const obj = { a: { b: { c: 'd' } } };
const value = pathval.get(obj, 'a.b.c');
console.log(value); // Output: 'd'"}

Set value on object

This feature allows you to set a value on a nested object using a string path, creating any necessary sub-objects along the path.

{"const pathval = require('pathval');
const obj = {};
pathval.set(obj, 'a.b.c', 'd');
console.log(obj); // Output: { a: { b: { c: 'd' } } }"}

Other packages similar to pathval

lodash.get

lodash.get is a method from the Lodash library that retrieves the value at a given path of an object. It is similar to pathval's get functionality but is part of a larger utility library.

dot-prop

dot-prop is a package that allows you to get, set, or delete properties from a nested object using a dot path. It is similar to pathval but also includes delete functionality.

object-path

object-path is a package that provides a full set of methods to manage paths on objects, including get, set, push, ensure, and more. It offers a broader feature set compared to pathval.

README

pathval

Tool for Object value retrieval given a string path for node and the browser.

What is pathval?

Pathval is a module which you can use to retrieve or set an Object's property for a given String path.

Installation

Node.js

pathval is available on npm. To install it, type:

$ npm install pathval

Browsers

You can also use it within the browser; install via npm and use the pathval.js file found within the download. For example:

<script src="./node_modules/pathval/pathval.js"></script>

Usage

The primary export of pathval is an object which has the following methods:

• hasProperty(object, name) - Checks whether an object has named property or numeric array index.
• getPathInfo(object, path) - Returns an object with info indicating the value of the parent of that path, the name of the property we're retrieving and its value.
• getPathValue(object, path) - Retrieves the value of a property at a given path inside an object'.
• setPathValue(object, path, value) - Sets the value of a property at a given path inside an object and returns the object in which the property has been set.

var pathval = require('pathval');

.hasProperty(object, name)

var pathval = require('pathval');

var obj = { prop: 'a value' };
pathval.hasProperty(obj, 'prop'); // true

.getPathInfo(object, path)

var pathval = require('pathval');

var obj = { earth: { country: 'Brazil' } };
pathval.getPathInfo(obj, 'earth.country'); // { parent: { country: 'Brazil'  }, name: 'country', value: 'Brazil', exists: true }

.getPathValue(object, path)

var pathval = require('pathval');

var obj = { earth: { country: 'Brazil' } };
pathval.getPathValue(obj, 'earth.country'); // 'Brazil'

.setPathValue(object, path, value)

var pathval = require('pathval');

var obj = { earth: { country: 'Brazil' } };
pathval.setPathValue(obj, 'earth.country', 'USA');

obj.earth.country; // 'USA'