Have ideas to improve npm?Join in the discussion! »

    set-value
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/set-value package

    4.0.0 • Public • Published

    set-value Donate NPM version NPM monthly downloads NPM total downloads

    Set nested properties on an object using dot notation.

    Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

    Install

    Install with npm (requires Node.js >=11.0):

    $ npm install --save set-value

    Heads up!

    Please update to version 3.0.1 or later, a critical bug was fixed in that version.

    Usage

    const set = require('set-value');
    
    const obj = {};
    set(obj, 'a.b.c', 'd');
    
    console.log(obj);
    //=> { a: { b: { c: 'd' } } }

    Params

    Signature:

    set(object, property_path, value[, options]);
    • object {Object}: The object to set value on
    • path {String|Symbol|Array}: The path of the property to set.
    • value {any}: The value to set on obj[prop]
    • options {Object}: See all available options

    Object paths

    You may pass a string, symbol, or array of strings or symbols. By default, when a string is passed this library will split the string on . or a custom separator It's useful to pass an array

    Escaping

    Escaping with backslashes

    Prevent set-value from splitting on a dot by prefixing it with backslashes:

    console.log(set({}, 'a\\.b.c', 'd'));
    //=> { 'a.b': { c: 'd' } }
    
    console.log(set({}, 'a\\.b\\.c', 'd'));
    //=> { 'a.b.c': 'd' }

    Options

    options.preservePaths

    Do not split properties that include a /. By default, set-value assumes that properties with a / are not intended to be split. This option allows you to disable default behavior.

    Note that this option cannot be used if options.separator is set to /.

    Type: boolean

    Default: true

    Example

    console.log(set({}, 'https://github.com', true));
    //=> { 'https://github.com': true }
    
    console.log(set({}, 'https://github.com', true, { preservePaths: false }));
    //=> { 'https://github': { com: true } }

    options.separator

    Custom separator to use for splitting object paths.

    Type: string

    Default: .

    Example

    console.log(set(obj, 'auth/userpass/users/bob', '*****', { separator: '/' }));
    //=> { auth: { userpass: { users: { bob: '*****' } } } }

    options.split

    Custom .split() function to use.

    options.merge

    Allows you to update plain object values, instead of overwriting them.

    Type: boolean|function - A custom merge function may be defined if you need to deep merge. Otherwise, when merge is true, a shallow merge will be performed by Object.assign().

    Default: undefined

    Example

    const obj = { foo: { bar: { baz: 'qux' } } };
    set(obj, 'foo.bar.fez', 'zzz', { merge: true });
    //=> { foo: { bar: { baz: 'qux', fez: 'zzz' } } }

    Benchmarks

    Benchmarks were run on a MacBook Pro 2.5 GHz Intel Core i7, 16 GB 1600 MHz DDR3.

    # deep (194 bytes)
      deep-object x 879,975 ops/sec ±0.85% (94 runs sampled)
      deep-property x 1,746,617 ops/sec ±0.59% (96 runs sampled)
      deephas x 792,449 ops/sec ±0.61% (94 runs sampled)
      dot-prop x 1,258,403 ops/sec ±0.81% (93 runs sampled)
      dot2val x 2,096,518 ops/sec ±0.71% (94 runs sampled)
      es5-dot-prop x 1,627,431 ops/sec ±0.57% (94 runs sampled)
      lodash-set x 1,100,116 ops/sec ±0.80% (94 runs sampled)
      object-path-set x 1,292,062 ops/sec ±0.56% (91 runs sampled)
      object-set x 276,868 ops/sec ±0.60% (92 runs sampled)
      set-value x 2,587,076 ops/sec ±0.47% (92 runs sampled)
    
      fastest is set-value (by 210% avg)
    
    # medium (98 bytes)
      deep-object x 5,823,296 ops/sec ±0.63% (92 runs sampled)
      deep-property x 4,045,998 ops/sec ±0.69% (91 runs sampled)
      deephas x 1,237,999 ops/sec ±0.56% (92 runs sampled)
      dot-prop x 2,833,082 ops/sec ±0.82% (93 runs sampled)
      dot2val x 4,669,511 ops/sec ±0.50% (94 runs sampled)
      es5-dot-prop x 3,348,092 ops/sec ±0.71% (92 runs sampled)
      lodash-set x 3,051,898 ops/sec ±0.61% (94 runs sampled)
      object-path-set x 3,867,590 ops/sec ±0.48% (92 runs sampled)
      object-set x 888,369 ops/sec ±0.52% (96 runs sampled)
      set-value x 8,209,356 ops/sec ±0.68% (91 runs sampled)
    
      fastest is set-value (by 248% avg)
    
    # shallow (101 bytes)
      deep-object x 9,558,659 ops/sec ±0.81% (92 runs sampled)
      deep-property x 5,190,792 ops/sec ±0.72% (93 runs sampled)
      deephas x 1,395,091 ops/sec ±0.55% (90 runs sampled)
      dot-prop x 4,203,222 ops/sec ±0.67% (94 runs sampled)
      dot2val x 5,908,936 ops/sec ±0.52% (93 runs sampled)
      es5-dot-prop x 4,511,259 ops/sec ±0.65% (94 runs sampled)
      lodash-set x 8,624,572 ops/sec ±0.87% (90 runs sampled)
      object-path-set x 5,800,121 ops/sec ±0.73% (90 runs sampled)
      object-set x 1,629,494 ops/sec ±0.68% (92 runs sampled)
      set-value x 13,925,948 ops/sec ±0.68% (89 runs sampled)
    
      fastest is set-value (by 268% avg)
    
    

    Running the benchmarks

    Clone this library into a local directory:

    $ git clone https://github.com/jonschlinkert/set-value.git

    Then install devDependencies and run benchmarks:

    $ npm install && node benchmark

    Comparisons to other libs, or "the list of shame"

    These are just a few of the duplicate libraries on NPM.

    • bury fails all of the tests. I even wrapped it to have it return the object instead of the value, but with all of that work it still fails the vast majority of tests.
    • deep-get-set fails 22 of 26 unit tests.
    • deep-object fails 25 of 26 unit tests, completely butchered given objects.
    • deep-property fails 17 of 26 unit tests.
    • deep-set fails 13 of 26 unit tests.
    • deephas fails 17 of 26 unit tests.
    • dot-prop fails 9 of 26 unit tests.
    • dot2val fails 17 of 26 unit tests.
    • es5-dot-prop fails 15 of 26 unit tests.
    • getsetdeep fails all unit tests due to this being used improperly in the methods. I was able to patch it by binding the (plain) object to the methods, but it still fails 17 of 26 unit tests.
    • lodash.set fails 11 of 26 unit tests.
    • object-path-set fails 12 of 26 unit tests.
    • object-path fails 16 of 26 unit tests.
    • object-set fails 13 of 26 unit tests.
    • set-nested-prop fails 24 of 26 unit tests.
    • setvalue (this library is almost identical to a previous version of this library)
    • Many dozens of others

    Others that do the same thing, but use a completely different API

    History

    v3.0.0

    • Added support for a custom split function to be passed on the options.
    • Removed support for splitting on brackets, since a custom function can be passed to do this now.

    v2.0.0

    • Adds support for escaping with double or single quotes. See escaping for examples.
    • Will no longer split inside brackets or braces. See bracket support for examples.

    If there are any regressions please create a bug report. Thanks!

    About

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Running Tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test
    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Related projects

    You might also be interested in these projects:

    • assign-value: Assign a value or extend a deeply nested property of an object using object path… more | homepage
    • get-value: Use property paths like 'a.b.c' to get a nested value from an object. Even works… more | homepage
    • has-value: Returns true if a value exists, false if empty. Works with deeply nested values using… more | homepage
    • merge-value: Similar to assign-value but deeply merges object values or nested values using object path/dot notation. | homepage
    • omit-value: Omit properties from an object or deeply nested property of an object using object path… more | homepage
    • set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
    • union-value: Set an array of unique values as the property of an object. Supports setting deeply… more | homepage
    • unset-value: Delete nested properties from an object using dot notation. | homepage

    Contributors

    Commits Contributor
    83 jonschlinkert
    4 doowb
    2 mbelsky
    1 dkebler
    1 GlennKintscher
    1 petermorlion
    1 abetomo
    1 zeidoo
    1 wtgtybhertgeghgtwtg

    Author

    Jon Schlinkert

    License

    Copyright © 2021, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.8.0, on April 28, 2021.

    Install

    npm i set-value

    DownloadsWeekly Downloads

    18,403,459

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    20.5 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar