summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md')
-rw-r--r--deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md51
1 files changed, 0 insertions, 51 deletions
diff --git a/deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md b/deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md
deleted file mode 100644
index a2981ea070..0000000000
--- a/deps/npm/node_modules/mississippi/node_modules/end-of-stream/node_modules/once/README.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# once
-
-Only call a function once.
-
-## usage
-
-```javascript
-var once = require('once')
-
-function load (file, cb) {
- cb = once(cb)
- loader.load('file')
- loader.once('load', cb)
- loader.once('error', cb)
-}
-```
-
-Or add to the Function.prototype in a responsible way:
-
-```javascript
-// only has to be done once
-require('once').proto()
-
-function load (file, cb) {
- cb = cb.once()
- loader.load('file')
- loader.once('load', cb)
- loader.once('error', cb)
-}
-```
-
-Ironically, the prototype feature makes this module twice as
-complicated as necessary.
-
-To check whether you function has been called, use `fn.called`. Once the
-function is called for the first time the return value of the original
-function is saved in `fn.value` and subsequent calls will continue to
-return this value.
-
-```javascript
-var once = require('once')
-
-function load (cb) {
- cb = once(cb)
- var stream = createStream()
- stream.once('data', cb)
- stream.once('end', function () {
- if (!cb.called) cb(new Error('not found'))
- })
-}
-```