diff options
author | Minteck <contact@minteck.org> | 2022-06-04 08:51:19 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-06-04 08:51:19 +0200 |
commit | b22f6770c8bd084d66950655203c61dd701b3d90 (patch) | |
tree | 873d7fb19584ec2709b95cc1ca05a1fc7cfd0fc4 /node_modules/dot-prop/readme.md | |
parent | 383285ecd5292bf9a825e05904955b937de84cc9 (diff) | |
download | equestriadb-b22f6770c8bd084d66950655203c61dd701b3d90.tar.gz equestriadb-b22f6770c8bd084d66950655203c61dd701b3d90.tar.bz2 equestriadb-b22f6770c8bd084d66950655203c61dd701b3d90.zip |
Remove node_modules
Diffstat (limited to 'node_modules/dot-prop/readme.md')
-rw-r--r-- | node_modules/dot-prop/readme.md | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/node_modules/dot-prop/readme.md b/node_modules/dot-prop/readme.md deleted file mode 100644 index 4170565..0000000 --- a/node_modules/dot-prop/readme.md +++ /dev/null @@ -1,117 +0,0 @@ -# dot-prop [![Build Status](https://travis-ci.org/sindresorhus/dot-prop.svg?branch=master)](https://travis-ci.org/sindresorhus/dot-prop) - -> Get, set, or delete a property from a nested object using a dot path - - -## Install - -``` -$ npm install dot-prop -``` - - -## Usage - -```js -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?) - -### set(object, path, value) - -Returns the object. - -### has(object, path) - -### delete(object, 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. - - ---- - -<div align="center"> - <b> - <a href="https://tidelift.com/subscription/pkg/npm-dot-prop?utm_source=npm-dot-prop&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> - </b> - <br> - <sub> - Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. - </sub> -</div> |