New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details
Socket
Book a DemoSign in
Socket

jaunt

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jaunt

Get or set a value in an object/array using a dot-delimited string or array of keys.

latest
Source
npmnpm
Version
1.3.0
Version published
Weekly downloads
576
84.62%
Maintainers
1
Weekly downloads
 
Created
Source

Jaunt.js npm Version Build Status Coverage Status

Get or set a value in an object/array using a dot-delimited string or array of keys.

API

jaunt.get(obj, path)

Returns the value in obj corresponding to path. Returns undefined if path does not exist.

  • obj — An object or array.
  • path — A dot-delimited string of keys, or an array of keys.
var obj = {
  foo: {
    bar: ['Hello', 'World'],
    baz: 'Goodbye'
  }
};

jaunt.get(obj, 'foo.bar'); //=> ['Hello', 'World']
jaunt.get(obj, 'foo.baz'); //=> 'Goodbye'

jaunt.get(obj, 'foo.bar.0'); //=> 'Hello'
jaunt.get(obj, 'foo.baz.0'); //=> 'Goodbye'

jaunt.get(obj, ['foo', 'bar', 0]); //=> 'World'
jaunt.get(obj, ['foo', 'baz', 0]); //=> 'Goodbye'

jaunt.get(obj, 'invalid'); //=> undefined

There can be a trailing “0” in path if it corresponds to a leaf node. So, in the example above, the paths foo.baz and foo.baz.0 are equivalent.

jaunt.set(obj, path, val)

Sets the element corresponding to path in the obj to the specified val. Any “intermediate” elements in the path will be created if they do not exist. Returns the modified obj.

  • obj — An object or array.
  • path — A dot-delimited string of keys, or an array of keys.
  • val — The value to set the element corresponding to path.
var obj = {
  foo: {
    bar: ['Hello', 'World']
  }
};

jaunt.set(obj, 'foo.bar.0', 'Hola');
/* =>
 * {
 *   foo: {
 *     bar: ['Hola', 'World']
 *   }
 * }
 */

jaunt.set(obj, 'baz', 'Shiny!');
/* =>
 * {
 *   foo: {
 *     bar: ['Hola', 'World']
 *   },
 *   baz: 'Shiny!'
 * }
 */

Installation

Install via npm:

$ npm i --save jaunt

Install via bower:

$ bower i --save yuanqing/jaunt

To use Jaunt in the browser, include the minified script in your HTML:

<body>
  <!-- ... -->
  <script src="path/to/dist/jaunt.min.js"></script>
  <script>
    // jaunt available here
  </script>
</body>

Changelog

  • 1.3.0
    • Allow trailing “0” in path for the get method
  • 1.2.0
    • Migrate tests to tape
  • 1.1.3
    • Expose module for use in the browser
    • Add minified version of the module
    • Add bower.json
  • 1.0.0
    • Initial release

License

MIT license

Keywords

array

FAQs

Package last updated on 01 Jan 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts