diff options
| author | Rich Trott <rtrott@gmail.com> | 2017-12-06 10:15:58 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2017-12-07 13:49:53 -0800 |
| commit | de06dc92d150c1f999462a18c7594a5eea81225f (patch) | |
| tree | e2135d603ad97a3dd4d2f803b562688ce49a48f2 | |
| parent | 86d386a07d3bb7d13c0b174f37cf2bc1d00dee51 (diff) | |
| download | android-node-v8-de06dc92d150c1f999462a18c7594a5eea81225f.tar.gz android-node-v8-de06dc92d150c1f999462a18c7594a5eea81225f.tar.bz2 android-node-v8-de06dc92d150c1f999462a18c7594a5eea81225f.zip | |
doc: fix common typo involving one-time listeners
Our docs use both "one time listener" and "one-time listener". The
second is more correct. Standardize on that.
PR-URL: https://github.com/nodejs/node/pull/17502
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
| -rw-r--r-- | doc/api/events.md | 4 | ||||
| -rw-r--r-- | doc/api/http.md | 2 | ||||
| -rw-r--r-- | doc/api/net.md | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/events.md b/doc/api/events.md index 443137f170..8eaa8cae10 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -409,7 +409,7 @@ added: v0.3.0 * `eventName` {any} The name of the event. * `listener` {Function} The callback function -Adds a **one time** `listener` function for the event named `eventName`. The +Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. ```js @@ -464,7 +464,7 @@ added: v6.0.0 * `eventName` {any} The name of the event. * `listener` {Function} The callback function -Adds a **one time** `listener` function for the event named `eventName` to the +Adds a **one-time** `listener` function for the event named `eventName` to the *beginning* of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. diff --git a/doc/api/http.md b/doc/api/http.md index cb4eff0732..9f06296e6e 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1785,7 +1785,7 @@ This function allows one to transparently issue requests. string, it is automatically parsed with [`url.parse()`][]. If it is a [`URL`][] object, it will be automatically converted to an ordinary `options` object. -The optional `callback` parameter will be added as a one time listener for +The optional `callback` parameter will be added as a one-time listener for the [`'response'`][] event. `http.request()` returns an instance of the [`http.ClientRequest`][] diff --git a/doc/api/net.md b/doc/api/net.md index 04821ad2e9..03ed3d5cbc 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -802,7 +802,7 @@ socket.on('timeout', () => { If `timeout` is 0, then the existing idle timeout is disabled. -The optional `callback` parameter will be added as a one time listener for the +The optional `callback` parameter will be added as a one-time listener for the [`'timeout'`][] event. ### socket.unref() |