aboutsummaryrefslogtreecommitdiff
path: root/node_modules/defaults/README.md
diff options
context:
space:
mode:
authorScoots Dash <contact@minteck.org>2022-04-23 14:12:30 +0000
committerScoots Dash <contact@minteck.org>2022-04-23 14:12:30 +0000
commita927497b43cbe1438f3d7478932f3f7d03ea347c (patch)
tree0a3c88978b4294fb30afad58daa86c46fbedc2f6 /node_modules/defaults/README.md
parentba5fa694351774f2684c1aefdc215da5c6f39ba6 (diff)
parentf0db5bbbcd623812a391862d217519afafe197c6 (diff)
downloadtwilight-a927497b43cbe1438f3d7478932f3f7d03ea347c.tar.gz
twilight-a927497b43cbe1438f3d7478932f3f7d03ea347c.tar.bz2
twilight-a927497b43cbe1438f3d7478932f3f7d03ea347c.zip
Merge branch 'deprecation' into 'trunk'HEADtrunk
Disable the Twilight Package Manager See merge request minteck/twilight!1
Diffstat (limited to 'node_modules/defaults/README.md')
-rw-r--r--node_modules/defaults/README.md43
1 files changed, 0 insertions, 43 deletions
diff --git a/node_modules/defaults/README.md b/node_modules/defaults/README.md
deleted file mode 100644
index 1a4a2ea..0000000
--- a/node_modules/defaults/README.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# 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)