You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 17, 2021. It is now read-only.
Copy file name to clipboardexpand all lines: docs/api.md
+16-39
Original file line number
Diff line number
Diff line change
@@ -9,148 +9,125 @@ You may also be interested in [the guide](https://github.com/Wolfy87/EventEmitte
9
9
<p>Class for managing events.<br />Can be extended to provide event functionality in other classes.</p>
10
10
11
11
***class** - [object Object]
12
-
13
12
## getListeners
14
13
15
14
<p>Returns the listener array for the specified event.<br />Will initialise the event object and listener arrays if required.<br />Will return an object if you use a regex search. The object contains keys for each matched event. So /ba[rz]/ might return an object containing bar and baz. But only if you have either defined them with defineEvent or added some listeners to them.<br />Each property in the object response is an array of listener functions.</p>
16
15
17
-
***param** (String | RegExp) _evt_ - Name of the event to return the listeners from.
18
-
***return** (Function[] | Object) - All listener functions for the event.
19
-
16
+
***param** (StringRegExp) _evt_ - Name of the event to return the listeners from.
17
+
***return** (Function[]Object) - All listener functions for the event.
20
18
## flattenListeners
21
19
22
20
<p>Takes a list of listener objects and flattens it into a list of listener functions.</p>
23
21
24
22
***param** (Object[]) _listeners_ - Raw listener objects.
25
23
***return** (Function[]) - Just the listener functions.
26
-
27
24
## getListenersAsObject
28
25
29
26
<p>Fetches the requested listeners via getListeners but will always return the results inside an object. This is mainly for internal use but others may find it useful.</p>
30
27
31
-
***param** (String | RegExp) _evt_ - Name of the event to return the listeners from.
28
+
***param** (StringRegExp) _evt_ - Name of the event to return the listeners from.
32
29
***return** (Object) - All listener functions for an event in an object.
33
-
34
30
## addListener
35
31
36
32
<p>Adds a listener function to the specified event.<br />The listener will not be added if it is a duplicate.<br />If the listener returns true then it will be removed after it is called.<br />If you pass a regular expression as the event name then the listener will be added to all events that match it.</p>
37
33
38
-
***param** (String | RegExp) _evt_ - Name of the event to attach the listener to.
34
+
***param** (StringRegExp) _evt_ - Name of the event to attach the listener to.
39
35
***param** (Function) _listener_ - Method to be called when the event is emitted. If the function returns true then it will be removed after calling.
40
36
***return** (Object) - Current instance of EventEmitter for chaining.
41
-
42
37
## on
43
38
44
39
<p>Alias of addListener</p>
45
40
46
-
47
41
## addOnceListener
48
42
49
-
<p>Semi-alias of addListener. It will add a listener that will be<br />automatically removed after it's first execution.</p>
43
+
<p>Semi-alias of addListener. It will add a listener that will be<br />automatically removed after its first execution.</p>
50
44
51
-
***param** (String | RegExp) _evt_ - Name of the event to attach the listener to.
45
+
***param** (StringRegExp) _evt_ - Name of the event to attach the listener to.
52
46
***param** (Function) _listener_ - Method to be called when the event is emitted. If the function returns true then it will be removed after calling.
53
47
***return** (Object) - Current instance of EventEmitter for chaining.
54
-
55
48
## once
56
49
57
50
<p>Alias of addOnceListener.</p>
58
51
59
-
60
52
## defineEvent
61
53
62
-
<p>Defines an event name. This is required if you want to use a regex to add a listener to multiple events at once. If you don't do this then how do you expect it to know what event to add to? Should it just add to every possible match for a regex? No. That is scary and bad.<br />You need to tell it what event names should be matched by a regex.</p>
54
+
<p>Defines an event name. This is required if you want to use a regex to add a listener to multiple events at once. If you don't do this then how do you expect it to know what event to add to? Should it just add to every possible match for a regex? No. That is scary and bad.<br />You need to tell it what event names should be matched by a regex.</p>
63
55
64
56
***param** (String) _evt_ - Name of the event to create.
65
57
***return** (Object) - Current instance of EventEmitter for chaining.
66
-
67
58
## defineEvents
68
59
69
60
<p>Uses defineEvent to define multiple events.</p>
70
61
71
62
***param** (String[]) _evts_ - An array of event names to define.
72
63
***return** (Object) - Current instance of EventEmitter for chaining.
73
-
74
64
## removeListener
75
65
76
66
<p>Removes a listener function from the specified event.<br />When passed a regular expression as the event name, it will remove the listener from all events that match it.</p>
77
67
78
-
***param** (String | RegExp) _evt_ - Name of the event to remove the listener from.
68
+
***param** (StringRegExp) _evt_ - Name of the event to remove the listener from.
79
69
***param** (Function) _listener_ - Method to remove from the event.
80
70
***return** (Object) - Current instance of EventEmitter for chaining.
81
-
82
71
## off
83
72
84
73
<p>Alias of removeListener</p>
85
74
86
-
87
75
## addListeners
88
76
89
-
<p>Adds listeners in bulk using the manipulateListeners method.<br />If you pass an object as the second argument you can add to multiple events at once. The object should contain key value pairs of events and listeners or listener arrays. You can also pass it an event name and an array of listeners to be added.<br />You can also pass it a regular expression to add the array of listeners to all events that match it.<br />Yeah, this function does quite a bit. That's probably a bad thing.</p>
77
+
<p>Adds listeners in bulk using the manipulateListeners method.<br />If you pass an object as the second argument you can add to multiple events at once. The object should contain key value pairs of events and listeners or listener arrays. You can also pass it an event name and an array of listeners to be added.<br />You can also pass it a regular expression to add the array of listeners to all events that match it.<br />Yeah, this function does quite a bit. That's probably a bad thing.</p>
90
78
91
-
***param** (String | Object | RegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to add to multiple events at once.
79
+
***param** (StringObjectRegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to add to multiple events at once.
92
80
***param** (Function[]) _[listeners]_ - An optional array of listener functions to add.
93
81
***return** (Object) - Current instance of EventEmitter for chaining.
94
-
95
82
## removeListeners
96
83
97
84
<p>Removes listeners in bulk using the manipulateListeners method.<br />If you pass an object as the second argument you can remove from multiple events at once. The object should contain key value pairs of events and listeners or listener arrays.<br />You can also pass it an event name and an array of listeners to be removed.<br />You can also pass it a regular expression to remove the listeners from all events that match it.</p>
98
85
99
-
***param** (String | Object | RegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to remove from multiple events at once.
86
+
***param** (StringObjectRegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to remove from multiple events at once.
100
87
***param** (Function[]) _[listeners]_ - An optional array of listener functions to remove.
101
88
***return** (Object) - Current instance of EventEmitter for chaining.
102
-
103
89
## manipulateListeners
104
90
105
91
<p>Edits listeners in bulk. The addListeners and removeListeners methods both use this to do their job. You should really use those instead, this is a little lower level.<br />The first argument will determine if the listeners are removed (true) or added (false).<br />If you pass an object as the second argument you can add/remove from multiple events at once. The object should contain key value pairs of events and listeners or listener arrays.<br />You can also pass it an event name and an array of listeners to be added/removed.<br />You can also pass it a regular expression to manipulate the listeners of all events that match it.</p>
106
92
107
93
***param** (Boolean) _remove_ - True if you want to remove listeners, false if you want to add.
108
-
***param** (String | Object | RegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to add/remove from multiple events at once.
94
+
***param** (StringObjectRegExp) _evt_ - An event name if you will pass an array of listeners next. An object if you wish to add/remove from multiple events at once.
109
95
***param** (Function[]) _[listeners]_ - An optional array of listener functions to add/remove.
110
96
***return** (Object) - Current instance of EventEmitter for chaining.
111
-
112
97
## removeEvent
113
98
114
99
<p>Removes all listeners from a specified event.<br />If you do not specify an event then all listeners will be removed.<br />That means every event will be emptied.<br />You can also pass a regex to remove all events that match it.</p>
115
100
116
-
***param** (String | RegExp) _[evt]_ - Optional name of the event to remove all listeners for. Will remove from every event if not passed.
101
+
***param** (StringRegExp) _[evt]_ - Optional name of the event to remove all listeners for. Will remove from every event if not passed.
117
102
***return** (Object) - Current instance of EventEmitter for chaining.
118
-
119
103
## removeAllListeners
120
104
121
-
<p>Alias of removeEvent.</p>
122
-
123
-
<p>Added to mirror the node API.</p>
124
-
105
+
<p>Alias of removeEvent.</p><p>Added to mirror the node API.</p>
125
106
126
107
## emitEvent
127
108
128
109
<p>Emits an event of your choice.<br />When emitted, every listener attached to that event will be executed.<br />If you pass the optional argument array then those arguments will be passed to every listener upon execution.<br />Because it uses <code>apply</code>, your array of arguments will be passed as if you wrote them out separately.<br />So they will not arrive within the array on the other side, they will be separate.<br />You can also pass a regular expression to emit to all events that match it.</p>
129
110
130
-
***param** (String | RegExp) _evt_ - Name of the event to emit and execute listeners for.
111
+
***param** (StringRegExp) _evt_ - Name of the event to emit and execute listeners for.
131
112
***param** (Array) _[args]_ - Optional array of arguments to be passed to each listener.
132
113
***return** (Object) - Current instance of EventEmitter for chaining.
133
-
134
114
## trigger
135
115
136
116
<p>Alias of emitEvent</p>
137
117
138
-
139
118
## emit
140
119
141
120
<p>Subtly different from emitEvent in that it will pass its arguments on to the listeners, as opposed to taking a single array of arguments to pass on.<br />As with emitEvent, you can pass a regex in place of the event name to emit to all events that match it.</p>
142
121
143
-
***param** (String | RegExp) _evt_ - Name of the event to emit and execute listeners for.
122
+
***param** (StringRegExp) _evt_ - Name of the event to emit and execute listeners for.
144
123
***param** (...*) _Optional_ - additional arguments to be passed to each listener.
145
124
***return** (Object) - Current instance of EventEmitter for chaining.
146
-
147
125
## setOnceReturnValue
148
126
149
127
<p>Sets the current value to check against when executing listeners. If a<br />listeners return value matches the one set here then it will be removed<br />after execution. This value defaults to true.</p>
150
128
151
129
***param** (*) _value_ - The new value to check for when executing listeners.
152
130
***return** (Object) - Current instance of EventEmitter for chaining.
153
-
154
131
## noConflict
155
132
156
133
<p>Reverts the global {@link EventEmitter} to its previous value and returns a reference to this version.</p>
0 commit comments