Need help with dot-prop?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
481 Stars 51 Forks MIT License 83 Commits 4 Opened issues

Description

Get, set, or delete a property from a nested object using a dot path

Services available

!
?

Need anything else?

Contributors list

No Data

dot-prop Build Status

Get, set, or delete a property from a nested object using a dot path

Install

$ npm install dot-prop

Usage

const dotProp = require('dot-prop');

// Getter dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar'); //=> 'unicorn'

dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep'); //=> undefined

dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value'); //=> 'default value'

dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\.dot'); //=> 'unicorn'

// Setter const object = {foo: {bar: 'a'}}; dotProp.set(object, 'foo.bar', 'b'); console.log(object); //=> {foo: {bar: 'b'}}

const foo = dotProp.set({}, 'foo.bar', 'c'); console.log(foo); //=> {foo: {bar: 'c'}}

dotProp.set(object, 'foo.baz', 'x'); console.log(object); //=> {foo: {bar: 'b', baz: 'x'}}

// Has dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar'); //=> true

// Deleter const object = {foo: {bar: 'a'}}; dotProp.delete(object, 'foo.bar'); console.log(object); //=> {foo: {}}

object.foo.bar = {x: 'y', y: 'x'}; dotProp.delete(object, 'foo.bar.x'); console.log(object); //=> {foo: {bar: {y: 'x'}}}

API

get(object, path, defaultValue?)

Get the value of the property at the given path.

Returns the value if any.

set(object, path, value)

Set the property at the given path to the given value.

Returns the object.

has(object, path)

Check whether the property at the given path exists.

Returns a boolean.

delete(object, path)

Delete the property at the given path.

Returns a boolean of whether the property existed before being deleted.

object

Type:

object

Object to get, set, or delete the

path
value.

You are allowed to pass in

undefined
as the object to the
get
and
has
functions.

path

Type:

string

Path of the property in the object, using

.
to separate each nested key.

Use

\\.
if you have a
.
in the key.

The following path components are invalid and results in

undefined
being returned:
__proto__
,
prototype
,
constructor
.

value

Type:

unknown

Value to set at

path
.

defaultValue

Type:

unknown

Default value.


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.