aboutsummaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/lazy-property/README.md
blob: d339c8f460e73b2b324f1b772bcc131da7566f75 (plain)
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
lazy-property
=============
Adds a lazily initialized property to an object.

## Example

```javascript
var addLazyProperty = require("lazy-property")

var obj = {}

addLazyProperty(obj, "foo", function() {
  console.log("initialized!")
  return "bar"
})

//Access the property
console.log(obj.foo)
console.log(obj.foo)

//Prints out:
//
//    initialized!
//    bar
//    bar
//
```

## Install

    npm install lazy-property

## API

### `require("lazy-property")(obj, name, init[, enumerable])`
Adds a lazily initialized property to the object.

* `obj` is the object to add the property to
* `name` is the name of the property
* `init` is a function that computes the value of the property
* `enumerable` if the property is enumerable (default `false`)

## Credits
(c) 2013 Mikola Lysenko. MIT License