blob: 76f9efd3ad4e7f7cec80a6ea37d74f3de601bcef (
plain)
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
<!-- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
The `events` module provides base API for emitting events.
This module is not intended to be used directly by programs. Rather, it is
intended to be used by other modules that provide APIs to programs.
<api name="EventEmitter">
@class
The EventEmitter is the base building block for all compositions that
would need to broadcast data to multiple consumers.
Please note that `EventEmitter` does not expose either a method for emitting
events or a list of available event listeners as its public API. Obviously
both are accessible but from the instance itself through the private API.
<api name="EventEmitter">
@constructor
Creates an EventEmitter object.
</api>
<api name="on">
@method
Registers an event `listener` that will be called when events of
specified `type` are emitted.
If the `listener` is already registered for this `type`, a call to this
method has no effect.
If the event listener is being registered while an event is being processed,
the event listener is not called during the current emit.
**Example:**
// worker is instance of EventEmitter
worker.on('message', function (data) {
console.log('data received: ' + data)
});
@param type {String}
The type of the event.
@param listener {Function}
The listener function that processes the event.
</api>
<api name="once">
@method
Registers an event `listener` that will only be called once, the next time
an event of the specified `type` is emitted.
If the event listener is registered while an event of the specified `type`
is being emitted, the event listener will not be called during the current
emit.
@param type {String}
The type of the event.
@param listener {Function}
The listener function that processes the event.
</api>
<api name="removeListener">
@method
Unregisters an event `listener` for the specified event `type`.
If the `listener` is not registered for this `type`, a call to this
method has no effect.
If an event listener is removed while an event is being processed, it is
still triggered by the current emit. After it is removed, the event listener
is never invoked again (unless registered again for future processing).
@param type {String}
The type of the event.
@param listener {Function}
The listener function that processes the event.
</api>
</api>
|
