File: README.markdown

package info (click to toggle)
node-delve 0.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 72 kB
  • sloc: javascript: 85; makefile: 2
file content (58 lines) | stat: -rw-r--r-- 1,281 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# delve
Delve recursively into a value to retrieve a property; without erroring.

[![browser support](https://ci.testling.com/hughfdjackson/delve.png)](http://ci.testling.com/hughfdjackson/delve)

## Why
It sucks to have to do `if ( obj && obj.prop && obj.prop.secondProp ) { ... }`.

## Example

### delve

```javascript
var delve = require('delve')

var o = { x: { y: { z: 'my val' } } }

delve(o, 'x.y')               //= { z: 'my val' }
delve(o, 'x.y.z')             //= 'my val'
delve(o, 'x.y.z.foo')         //= undefined
delve(undefined, 'x.y.z.foo') //= undefined
delve(null, 'x.y.z.foo')      //= undefined
delve('foo', 'length')        //= 3
```
### delve.has

```javascript
var delve = require('delve')

delve.has({ x: { y: undefined } }, 'x.y') //= true
delve.has('foo', 'length')                //= true
delve.has(null, 'foo')                    //= false
delve.has({ x: { } }, 'x.y')              //= false
```

For more examples, see tests/delve-test.js.

## Install

### npm

```bash
npm install delve
```

### browser

Download src/delve.js, and include it as a script tag.

### AMD/require.js

Download src/delve.js, and require it in:

```javascript
require(['libs/delve'], function(delve){
  // ... assuming delve is in libs/delve, now it's ready to use
})
```