Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Clearly document the behavior of ee.once(). #6371

Closed
wants to merge 4 commits into from
Closed

docs: Clearly document the behavior of ee.once(). #6371

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28b9da8
docs: Clearly document the behavior of ee.once().
lance Apr 25, 2016
0fa1c90
doc: Clarity about timing for `once` listeners.
lance Apr 25, 2016
dc1049f
doc: Clarify behavior of `ee.prependOnceListener`.
lance Apr 25, 2016
4102e92
doc: Clarify wording for `ee.prependOnceListener`.
lance Apr 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions doc/api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ myEmitter.emit('event');
```

Using the `eventEmitter.once()` method, it is possible to register a listener
that is immediately unregistered after it is called.
that is unregistered before it is called.

```js
const myEmitter = new MyEmitter();
Expand Down Expand Up @@ -376,9 +376,8 @@ myEE.emit('foo');
* `eventName` {string|Symbol} The name of the event.
* `listener` {Function} The callback function

Adds a **one time** `listener` function for the event named `eventName`. This
listener is invoked only the next time `eventName` is triggered, after which
it is removed.
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
server.once('connection', (stream) => {
Expand Down Expand Up @@ -427,8 +426,8 @@ Returns a reference to the `EventEmitter` so calls can be chained.
* `listener` {Function} The callback function

Adds a **one time** `listener` function for the event named `eventName` to the
*beginning* of the listeners array. This listener is invoked only the next time
`eventName` is triggered, after which it is removed.
*beginning* of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.

```js
server.prependOnceListener('connection', (stream) => {
Expand Down