Blame view

node_modules/defaults/README.md 827 Bytes
ce4c83ff   wxy   初始提交
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
  # defaults
  
  A simple one level options merge utility
  
  ## install
  
  `npm install defaults`
  
  ## use
  
  ```javascript
  
  var defaults = require('defaults');
  
  var handle = function(options, fn) {
    options = defaults(options, {
      timeout: 100
    });
  
    setTimeout(function() {
      fn(options);
    }, options.timeout);
  }
  
  handle({ timeout: 1000 }, function() {
    // we're here 1000 ms later
  });
  
  handle({ timeout: 10000 }, function() {
    // we're here 10s later
  });
  
  ```
  
  ## summary
  
  this module exports a function that takes 2 arguments: `options` and `defaults`.  When called, it overrides all of `undefined` properties in `options` with the clones of properties defined in `defaults`
  
  Sidecases: if called with a falsy `options` value, options will be initialized to a new object before being merged onto.
  
  ## license
  
  [MIT](LICENSE)