https://github.com/developit/dlv

Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x')
https://github.com/developit/dlv

dlv javascript key object

Last synced: 20 days ago
JSON representation

Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x')

• Host: GitHub
• URL: https://github.com/developit/dlv
• Owner: developit
• Created: 2016-08-04T00:22:41.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-13T17:19:09.000Z (almost 4 years ago)
• Last Synced: 2024-10-12T23:11:14.995Z (22 days ago)
• Topics: dlv, javascript, key, object
• Language: JavaScript
• Homepage: https://npm.im/dlv
• Size: 25.4 KB
• Stars: 1,226
• Watchers: 9
• Forks: 41
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - dlv - Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x') (JavaScript)
• awesome-github-repos - developit/dlv - Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x') (JavaScript)
• awesome-github-star - dlv
• awesome-list - dlv
• awesome-node-esm - dlv - Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x') (Packages / Utility)

README

        
# `dlv(obj, keypath)` [![NPM](https://img.shields.io/npm/v/dlv.svg)](https://npmjs.com/package/dlv) [![Build](https://travis-ci.org/developit/dlv.svg?branch=master)](https://travis-ci.org/developit/dlv)

> Safely get a dot-notated path within a nested object, with ability to return a default if the full key path does not exist or the value is undefined

### Why?

Smallest possible implementation: only **120 bytes.**

You could write this yourself, but then you'd have to write [tests].

Supports ES Modules, CommonJS and globals.

### Installation

`npm install --save dlv`

### Usage

`delve(object, keypath, [default])`

```js

import delve from 'dlv';

let obj = {

	a: {

		b: {

			c: 1,

			d: undefined,

			e: null

		}

	}

};

//use string dot notation for keys

delve(obj, 'a.b.c') === 1;

//or use an array key

delve(obj, ['a', 'b', 'c']) === 1;

delve(obj, 'a.b') === obj.a.b;

//returns undefined if the full key path does not exist and no default is specified

delve(obj, 'a.b.f') === undefined;

//optional third parameter for default if the full key in path is missing

delve(obj, 'a.b.f', 'foo') === 'foo';

//or if the key exists but the value is undefined

delve(obj, 'a.b.d', 'foo') === 'foo';

//Non-truthy defined values are still returned if they exist at the full keypath

delve(obj, 'a.b.e', 'foo') === null;

//undefined obj or key returns undefined, unless a default is supplied

delve(undefined, 'a.b.c') === undefined;

delve(undefined, 'a.b.c', 'foo') === 'foo';

delve(obj, undefined, 'foo') === 'foo';

```

### Setter Counterparts

- [dset](https://github.com/lukeed/dset) by [@lukeed](https://github.com/lukeed) is the spiritual "set" counterpart of `dlv` and very fast.

- [bury](https://github.com/kalmbach/bury) by [@kalmbach](https://github.com/kalmbach) does the opposite of `dlv` and is implemented in a very similar manner.

### License

[MIT](https://oss.ninja/mit/developit/)

[preact]: https://github.com/developit/preact

[tests]: https://github.com/developit/dlv/blob/master/test.js