events-ex 2.0.0-alpha.1 → 2.0.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/LICENSE +1 -1
- package/README.cn.md +4 -2
- package/README.md +4 -2
- package/docs/README.md +4 -2
- package/docs/classes/event.Event.md +8 -8
- package/docs/classes/event_emitter-1.EventEmitter.md +25 -0
- package/docs/classes/{index.EventEmitter.md → event_emitter.EventEmitter.md} +36 -36
- package/docs/modules/all_off.md +4 -4
- package/docs/modules/consts.md +2 -1
- package/docs/modules/default_methods.md +6 -6
- package/docs/modules/event_emitter-1.md +19 -0
- package/docs/modules/event_emitter.md +3 -41
- package/docs/modules/has_listeners.md +1 -1
- package/docs/modules/index.md +16 -6
- package/docs/modules/pipe.md +3 -3
- package/docs/modules/pipe_async.md +3 -3
- package/docs/modules/unify.md +3 -3
- package/docs/modules/util_array_remove.md +1 -1
- package/docs/modules/util_object_for_each.md +1 -1
- package/docs/modules/util_string_pad.md +1 -1
- package/docs/modules/util_to_int.md +1 -1
- package/docs/modules/util_valid_callable.md +1 -1
- package/docs/modules/util_valid_object.md +1 -1
- package/docs/modules/wrap_event_emitter.md +57 -0
- package/docs/modules.md +2 -1
- package/lib/all-off.d.ts +3 -3
- package/lib/all-off.js +2 -2
- package/lib/consts.d.ts +2 -0
- package/lib/consts.js +3 -1
- package/lib/default-methods.d.ts +8 -8
- package/lib/default-methods.js +4 -4
- package/lib/event-emitter.d.ts +68 -6
- package/lib/event-emitter.js +8 -39
- package/lib/event.d.ts +6 -6
- package/lib/event.js +2 -2
- package/lib/index.d.ts +11 -78
- package/lib/index.js +22 -21
- package/lib/pipe-async.d.ts +3 -3
- package/lib/pipe-async.js +4 -4
- package/lib/pipe.d.ts +3 -3
- package/lib/pipe.js +4 -4
- package/lib/unify.d.ts +3 -3
- package/lib/unify.js +2 -2
- package/lib/wrap-event-emitter.d.ts +8 -0
- package/lib/wrap-event-emitter.js +47 -0
- package/package.json +2 -2
- package/src/all-off.js +2 -2
- package/src/consts.js +2 -0
- package/src/default-methods.js +4 -4
- package/src/{index.d.ts → event-emitter.d.ts} +0 -9
- package/src/event-emitter.js +6 -37
- package/src/event.js +2 -2
- package/src/index.js +2 -9
- package/src/pipe-async.js +3 -3
- package/src/pipe.js +3 -3
- package/src/unify.js +2 -2
- package/src/wrap-event-emitter.js +42 -0
- package/docs/classes/index-1.EventEmitter.md +0 -25
- package/docs/modules/index-1.md +0 -89
- package/test/add-listeners-test.js +0 -42
- package/test/all-off-test.js +0 -51
- package/test/check-listener-leaks-test.js +0 -76
- package/test/emitter-method-names-test.js +0 -11
- package/test/event-emitter-async-test.js +0 -152
- package/test/event-emitter-test.js +0 -145
- package/test/eventable-test.js +0 -108
- package/test/events-listeners-test.js +0 -46
- package/test/events-remove-listeners-test.js +0 -89
- package/test/has-listeners-test.js +0 -44
- package/test/listeners-side-effects-test.js +0 -40
- package/test/max-listeners-test.js +0 -33
- package/test/modify-in-emit-test.js +0 -121
- package/test/no-error-provided-to-error-event-test.js +0 -38
- package/test/num-args-test.js +0 -41
- package/test/once-test.js +0 -44
- package/test/pipe-async-test.js +0 -58
- package/test/pipe-test.js +0 -57
- package/test/remove-all-listeners-test.js +0 -74
- package/test/set-max-listeners-side-effects-test.js +0 -13
- package/test/subclass-test.js +0 -49
- package/test/unify-async-test.js +0 -122
- package/test/unify-test.js +0 -122
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,29 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
## [2.0.0-alpha.3](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.2...v2.0.0-alpha.3) (2023-08-27)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* add ABORT state constant ([a8b3710](https://github.com/snowyu/events-ex.js/commit/a8b3710ae7f1695263ed0bd9036db31831ed9ae0))
|
|
11
|
+
|
|
12
|
+
## [2.0.0-alpha.2](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.1...v2.0.0-alpha.2) (2023-06-13)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### ⚠ BREAKING CHANGES
|
|
16
|
+
|
|
17
|
+
* rename src/event-emitter to src/wrap-event-emitter and extract EventEmitter from index to event-emitter
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* **ts:** EventEmitter not found ([9a74862](https://github.com/snowyu/events-ex.js/commit/9a748624e00417f6d7f72ea7c297650e10895d19))
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Refactor
|
|
25
|
+
|
|
26
|
+
* rename src/event-emitter to src/wrap-event-emitter and extract EventEmitter from index to event-emitter ([f06f39f](https://github.com/snowyu/events-ex.js/commit/f06f39fb809006f5e098e31bb23870fff39ec5c8))
|
|
27
|
+
|
|
5
28
|
## [2.0.0-alpha.1](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.0...v2.0.0-alpha.1) (2023-06-13)
|
|
6
29
|
|
|
7
30
|
|
package/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Copyright (C)
|
|
1
|
+
Copyright (C) 2015-2023 Riceball LEE (snowyu.lee@gmail.com)
|
|
2
2
|
|
|
3
3
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
4
4
|
of this software and associated documentation files (the "Software"), to deal
|
package/README.cn.md
CHANGED
|
@@ -87,6 +87,7 @@ my.emit('event');
|
|
|
87
87
|
import {EventEmitter, states} from 'events-ex';
|
|
88
88
|
import {isObject} from 'util-ex';
|
|
89
89
|
|
|
90
|
+
states.ABORT = -1
|
|
90
91
|
class MyDb extends EventEmitter {
|
|
91
92
|
get(key) {
|
|
92
93
|
// Demo the event object bubbling usage:
|
|
@@ -108,8 +109,9 @@ db.on('getting', function(key){
|
|
|
108
109
|
state: states.DONE,
|
|
109
110
|
result: result,
|
|
110
111
|
}
|
|
111
|
-
|
|
112
|
-
|
|
112
|
+
this.stopped = true // it will skip other listeners if true
|
|
113
|
+
} else {
|
|
114
|
+
// you can abort to get key by default.
|
|
113
115
|
this.result = {state: states.ABORT};
|
|
114
116
|
// this.stopped = true // it will skip other listeners if true
|
|
115
117
|
}
|
package/README.md
CHANGED
|
@@ -77,6 +77,7 @@ Bubbling event usage:
|
|
|
77
77
|
import {EventEmitter, states} from 'events-ex';
|
|
78
78
|
import {isObject} from 'util-ex';
|
|
79
79
|
|
|
80
|
+
states.ABORT = -1
|
|
80
81
|
class MyDb extends EventEmitter {
|
|
81
82
|
get(key) {
|
|
82
83
|
// Demo the event object bubbling usage:
|
|
@@ -98,8 +99,9 @@ db.on('getting', function(key){
|
|
|
98
99
|
state: states.DONE,
|
|
99
100
|
result: result,
|
|
100
101
|
}
|
|
101
|
-
|
|
102
|
-
|
|
102
|
+
this.stopped = true // it will skip other listeners if true
|
|
103
|
+
} else {
|
|
104
|
+
// you can abort to get key by default.
|
|
103
105
|
this.result = {state: states.ABORT};
|
|
104
106
|
// this.stopped = true // it will skip other listeners if true
|
|
105
107
|
}
|
package/docs/README.md
CHANGED
|
@@ -77,6 +77,7 @@ Bubbling event usage:
|
|
|
77
77
|
import {EventEmitter, states} from 'events-ex';
|
|
78
78
|
import {isObject} from 'util-ex';
|
|
79
79
|
|
|
80
|
+
states.ABORT = -1
|
|
80
81
|
class MyDb extends EventEmitter {
|
|
81
82
|
get(key) {
|
|
82
83
|
// Demo the event object bubbling usage:
|
|
@@ -98,8 +99,9 @@ db.on('getting', function(key){
|
|
|
98
99
|
state: states.DONE,
|
|
99
100
|
result: result,
|
|
100
101
|
}
|
|
101
|
-
|
|
102
|
-
|
|
102
|
+
this.stopped = true // it will skip other listeners if true
|
|
103
|
+
} else {
|
|
104
|
+
// you can abort to get key by default.
|
|
103
105
|
this.result = {state: states.ABORT};
|
|
104
106
|
// this.stopped = true // it will skip other listeners if true
|
|
105
107
|
}
|
|
@@ -37,11 +37,11 @@ Event Object that contains information about the event, such as the target eleme
|
|
|
37
37
|
|
|
38
38
|
| Name | Type | Description |
|
|
39
39
|
| :------ | :------ | :------ |
|
|
40
|
-
| `target` | `EventEmitter` | Who trigger the event |
|
|
40
|
+
| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | Who trigger the event |
|
|
41
41
|
|
|
42
42
|
#### Defined in
|
|
43
43
|
|
|
44
|
-
[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/
|
|
44
|
+
[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L8)
|
|
45
45
|
|
|
46
46
|
## Properties
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ Keep your event result here if any.
|
|
|
53
53
|
|
|
54
54
|
#### Defined in
|
|
55
55
|
|
|
56
|
-
[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/
|
|
56
|
+
[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L38)
|
|
57
57
|
|
|
58
58
|
___
|
|
59
59
|
|
|
@@ -65,7 +65,7 @@ Whether stop the bubbling event
|
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/
|
|
68
|
+
[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L32)
|
|
69
69
|
|
|
70
70
|
___
|
|
71
71
|
|
|
@@ -77,7 +77,7 @@ Who trigger the event
|
|
|
77
77
|
|
|
78
78
|
#### Defined in
|
|
79
79
|
|
|
80
|
-
[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/
|
|
80
|
+
[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L26)
|
|
81
81
|
|
|
82
82
|
## Methods
|
|
83
83
|
|
|
@@ -95,7 +95,7 @@ The result of the event.
|
|
|
95
95
|
|
|
96
96
|
#### Defined in
|
|
97
97
|
|
|
98
|
-
[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/
|
|
98
|
+
[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L45)
|
|
99
99
|
|
|
100
100
|
___
|
|
101
101
|
|
|
@@ -109,7 +109,7 @@ Initializes the event with the target object.
|
|
|
109
109
|
|
|
110
110
|
| Name | Type | Description |
|
|
111
111
|
| :------ | :------ | :------ |
|
|
112
|
-
| `target` | `EventEmitter` | The target object for the event. |
|
|
112
|
+
| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | The target object for the event. |
|
|
113
113
|
|
|
114
114
|
#### Returns
|
|
115
115
|
|
|
@@ -117,4 +117,4 @@ Initializes the event with the target object.
|
|
|
117
117
|
|
|
118
118
|
#### Defined in
|
|
119
119
|
|
|
120
|
-
[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/
|
|
120
|
+
[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L20)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter-1.md) / EventEmitter
|
|
2
|
+
|
|
3
|
+
# Class: EventEmitter
|
|
4
|
+
|
|
5
|
+
[event-emitter](../modules/event_emitter-1.md).EventEmitter
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Constructors
|
|
10
|
+
|
|
11
|
+
- [constructor](event_emitter-1.EventEmitter.md#constructor)
|
|
12
|
+
|
|
13
|
+
## Constructors
|
|
14
|
+
|
|
15
|
+
### constructor
|
|
16
|
+
|
|
17
|
+
• **new EventEmitter**()
|
|
18
|
+
|
|
19
|
+
**`Classdesc`**
|
|
20
|
+
|
|
21
|
+
Class that represents an event emitter.
|
|
22
|
+
|
|
23
|
+
#### Defined in
|
|
24
|
+
|
|
25
|
+
[src/event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.js#L7)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[events-ex](../README.md) / [Exports](../modules.md) / [
|
|
1
|
+
[events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter.md) / EventEmitter
|
|
2
2
|
|
|
3
3
|
# Class: EventEmitter
|
|
4
4
|
|
|
5
|
-
[
|
|
5
|
+
[event-emitter](../modules/event_emitter.md).EventEmitter
|
|
6
6
|
|
|
7
7
|
Class that represents an event emitter.
|
|
8
8
|
|
|
@@ -10,24 +10,24 @@ Class that represents an event emitter.
|
|
|
10
10
|
|
|
11
11
|
### Constructors
|
|
12
12
|
|
|
13
|
-
- [constructor](
|
|
13
|
+
- [constructor](event_emitter.EventEmitter.md#constructor)
|
|
14
14
|
|
|
15
15
|
### Properties
|
|
16
16
|
|
|
17
|
-
- [defaultMaxListeners](
|
|
17
|
+
- [defaultMaxListeners](event_emitter.EventEmitter.md#defaultmaxlisteners)
|
|
18
18
|
|
|
19
19
|
### Methods
|
|
20
20
|
|
|
21
|
-
- [emit](
|
|
22
|
-
- [emitAsync](
|
|
23
|
-
- [listenerCount](
|
|
24
|
-
- [listeners](
|
|
25
|
-
- [off](
|
|
26
|
-
- [on](
|
|
27
|
-
- [once](
|
|
28
|
-
- [removeAllListeners](
|
|
29
|
-
- [setMaxListeners](
|
|
30
|
-
- [listenerCount](
|
|
21
|
+
- [emit](event_emitter.EventEmitter.md#emit)
|
|
22
|
+
- [emitAsync](event_emitter.EventEmitter.md#emitasync)
|
|
23
|
+
- [listenerCount](event_emitter.EventEmitter.md#listenercount)
|
|
24
|
+
- [listeners](event_emitter.EventEmitter.md#listeners)
|
|
25
|
+
- [off](event_emitter.EventEmitter.md#off)
|
|
26
|
+
- [on](event_emitter.EventEmitter.md#on)
|
|
27
|
+
- [once](event_emitter.EventEmitter.md#once)
|
|
28
|
+
- [removeAllListeners](event_emitter.EventEmitter.md#removealllisteners)
|
|
29
|
+
- [setMaxListeners](event_emitter.EventEmitter.md#setmaxlisteners)
|
|
30
|
+
- [listenerCount](event_emitter.EventEmitter.md#listenercount-1)
|
|
31
31
|
|
|
32
32
|
## Constructors
|
|
33
33
|
|
|
@@ -43,7 +43,7 @@ Class that represents an event emitter.
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[src/
|
|
46
|
+
[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L7)
|
|
47
47
|
|
|
48
48
|
## Methods
|
|
49
49
|
|
|
@@ -68,7 +68,7 @@ The result of the event.
|
|
|
68
68
|
|
|
69
69
|
#### Defined in
|
|
70
70
|
|
|
71
|
-
[src/
|
|
71
|
+
[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L38)
|
|
72
72
|
|
|
73
73
|
___
|
|
74
74
|
|
|
@@ -93,7 +93,7 @@ A promise that resolves with the result of the event.
|
|
|
93
93
|
|
|
94
94
|
#### Defined in
|
|
95
95
|
|
|
96
|
-
[src/
|
|
96
|
+
[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L44)
|
|
97
97
|
|
|
98
98
|
___
|
|
99
99
|
|
|
@@ -117,7 +117,7 @@ Returns the count of listeners that are registered to listen for the specified e
|
|
|
117
117
|
|
|
118
118
|
#### Defined in
|
|
119
119
|
|
|
120
|
-
[src/
|
|
120
|
+
[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L66)
|
|
121
121
|
|
|
122
122
|
___
|
|
123
123
|
|
|
@@ -141,13 +141,13 @@ Returns an array of functions that are registered to listen for the specified ev
|
|
|
141
141
|
|
|
142
142
|
#### Defined in
|
|
143
143
|
|
|
144
|
-
[src/
|
|
144
|
+
[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L59)
|
|
145
145
|
|
|
146
146
|
___
|
|
147
147
|
|
|
148
148
|
### off
|
|
149
149
|
|
|
150
|
-
▸ **off**(`eventName`, `listener`): [`EventEmitter`](
|
|
150
|
+
▸ **off**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
|
|
151
151
|
|
|
152
152
|
Removes a listener function from the specified event type.
|
|
153
153
|
|
|
@@ -164,19 +164,19 @@ If the listener is not a function.
|
|
|
164
164
|
|
|
165
165
|
#### Returns
|
|
166
166
|
|
|
167
|
-
[`EventEmitter`](
|
|
167
|
+
[`EventEmitter`](event_emitter.EventEmitter.md)
|
|
168
168
|
|
|
169
169
|
The EventEmitter instance to allow chaining.
|
|
170
170
|
|
|
171
171
|
#### Defined in
|
|
172
172
|
|
|
173
|
-
[src/
|
|
173
|
+
[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L32)
|
|
174
174
|
|
|
175
175
|
___
|
|
176
176
|
|
|
177
177
|
### on
|
|
178
178
|
|
|
179
|
-
▸ **on**(`eventName`, `listener`): [`EventEmitter`](
|
|
179
|
+
▸ **on**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
|
|
180
180
|
|
|
181
181
|
Adds a listener function to the specified event type.
|
|
182
182
|
|
|
@@ -193,19 +193,19 @@ If the listener is not a function.
|
|
|
193
193
|
|
|
194
194
|
#### Returns
|
|
195
195
|
|
|
196
|
-
[`EventEmitter`](
|
|
196
|
+
[`EventEmitter`](event_emitter.EventEmitter.md)
|
|
197
197
|
|
|
198
198
|
The EventEmitter instance to allow chaining.
|
|
199
199
|
|
|
200
200
|
#### Defined in
|
|
201
201
|
|
|
202
|
-
[src/
|
|
202
|
+
[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L16)
|
|
203
203
|
|
|
204
204
|
___
|
|
205
205
|
|
|
206
206
|
### once
|
|
207
207
|
|
|
208
|
-
▸ **once**(`eventName`, `listener`): [`EventEmitter`](
|
|
208
|
+
▸ **once**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
|
|
209
209
|
|
|
210
210
|
Adds a one-time listener function to the specified event type.
|
|
211
211
|
|
|
@@ -222,19 +222,19 @@ If the listener is not a function.
|
|
|
222
222
|
|
|
223
223
|
#### Returns
|
|
224
224
|
|
|
225
|
-
[`EventEmitter`](
|
|
225
|
+
[`EventEmitter`](event_emitter.EventEmitter.md)
|
|
226
226
|
|
|
227
227
|
The EventEmitter instance to allow chaining.
|
|
228
228
|
|
|
229
229
|
#### Defined in
|
|
230
230
|
|
|
231
|
-
[src/
|
|
231
|
+
[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L24)
|
|
232
232
|
|
|
233
233
|
___
|
|
234
234
|
|
|
235
235
|
### removeAllListeners
|
|
236
236
|
|
|
237
|
-
▸ **removeAllListeners**(`eventName?`): [`EventEmitter`](
|
|
237
|
+
▸ **removeAllListeners**(`eventName?`): [`EventEmitter`](event_emitter.EventEmitter.md)
|
|
238
238
|
|
|
239
239
|
Removes all listeners for a specific event or all events from an event emitter.
|
|
240
240
|
|
|
@@ -246,19 +246,19 @@ Removes all listeners for a specific event or all events from an event emitter.
|
|
|
246
246
|
|
|
247
247
|
#### Returns
|
|
248
248
|
|
|
249
|
-
[`EventEmitter`](
|
|
249
|
+
[`EventEmitter`](event_emitter.EventEmitter.md)
|
|
250
250
|
|
|
251
251
|
- The event emitter with all listeners removed.
|
|
252
252
|
|
|
253
253
|
#### Defined in
|
|
254
254
|
|
|
255
|
-
[src/
|
|
255
|
+
[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L51)
|
|
256
256
|
|
|
257
257
|
___
|
|
258
258
|
|
|
259
259
|
### setMaxListeners
|
|
260
260
|
|
|
261
|
-
▸ **setMaxListeners**(`n`): [`EventEmitter`](
|
|
261
|
+
▸ **setMaxListeners**(`n`): [`EventEmitter`](event_emitter.EventEmitter.md)
|
|
262
262
|
|
|
263
263
|
#### Parameters
|
|
264
264
|
|
|
@@ -268,11 +268,11 @@ ___
|
|
|
268
268
|
|
|
269
269
|
#### Returns
|
|
270
270
|
|
|
271
|
-
[`EventEmitter`](
|
|
271
|
+
[`EventEmitter`](event_emitter.EventEmitter.md)
|
|
272
272
|
|
|
273
273
|
#### Defined in
|
|
274
274
|
|
|
275
|
-
[src/
|
|
275
|
+
[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L52)
|
|
276
276
|
|
|
277
277
|
___
|
|
278
278
|
|
|
@@ -284,7 +284,7 @@ ___
|
|
|
284
284
|
|
|
285
285
|
| Name | Type |
|
|
286
286
|
| :------ | :------ |
|
|
287
|
-
| `emitter` | [`EventEmitter`](
|
|
287
|
+
| `emitter` | [`EventEmitter`](event_emitter.EventEmitter.md) |
|
|
288
288
|
| `eventName` | `string` |
|
|
289
289
|
|
|
290
290
|
#### Returns
|
|
@@ -293,4 +293,4 @@ ___
|
|
|
293
293
|
|
|
294
294
|
#### Defined in
|
|
295
295
|
|
|
296
|
-
[src/
|
|
296
|
+
[src/event-emitter.d.ts:67](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L67)
|
package/docs/modules/all_off.md
CHANGED
|
@@ -22,7 +22,7 @@ Renames and re-exports [allOff](all_off.md#alloff)
|
|
|
22
22
|
|
|
23
23
|
### allOff
|
|
24
24
|
|
|
25
|
-
▸ **allOff**(`emitter`, `type?`): `EventEmitter`
|
|
25
|
+
▸ **allOff**(`emitter`, `type?`): [`EventEmitter`](../classes/event_emitter.EventEmitter.md)
|
|
26
26
|
|
|
27
27
|
Removes all listeners for a specific event or all events from an event emitter.
|
|
28
28
|
|
|
@@ -30,15 +30,15 @@ Removes all listeners for a specific event or all events from an event emitter.
|
|
|
30
30
|
|
|
31
31
|
| Name | Type | Description |
|
|
32
32
|
| :------ | :------ | :------ |
|
|
33
|
-
| `emitter` | `EventEmitter` | The event emitter to remove listeners from. |
|
|
33
|
+
| `emitter` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The event emitter to remove listeners from. |
|
|
34
34
|
| `type?` | `string` | The event to remove listeners for. If not provided, all listeners for all events will be removed. |
|
|
35
35
|
|
|
36
36
|
#### Returns
|
|
37
37
|
|
|
38
|
-
`EventEmitter`
|
|
38
|
+
[`EventEmitter`](../classes/event_emitter.EventEmitter.md)
|
|
39
39
|
|
|
40
40
|
- The event emitter with all listeners removed.
|
|
41
41
|
|
|
42
42
|
#### Defined in
|
|
43
43
|
|
|
44
|
-
[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/
|
|
44
|
+
[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/all-off.js#L12)
|
package/docs/modules/consts.md
CHANGED
|
@@ -18,10 +18,11 @@
|
|
|
18
18
|
|
|
19
19
|
| Name | Type |
|
|
20
20
|
| :------ | :------ |
|
|
21
|
+
| `ABORT` | `number` |
|
|
21
22
|
| `CONTINUE` | `any` |
|
|
22
23
|
| `DONE` | `number` |
|
|
23
24
|
| `STOPPED` | `number` |
|
|
24
25
|
|
|
25
26
|
#### Defined in
|
|
26
27
|
|
|
27
|
-
[src/consts.js:
|
|
28
|
+
[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/consts.js#L6)
|
|
@@ -40,12 +40,12 @@ Renames and re-exports [getEventableMethods](default_methods.md#geteventablemeth
|
|
|
40
40
|
| `emitAsync` | (...`args`: `any`) => `Promise`<`any`\> |
|
|
41
41
|
| `listenerCount` | (`emitter`: `any`, `type`: `any`) => `any` |
|
|
42
42
|
| `listeners` | (`type`: `any`) => `any` |
|
|
43
|
-
| `off` | (`type`: `string`, `listener`: `Function`) => `EventEmitter` |
|
|
44
|
-
| `on` | (`type`: `string`, `listener`: `Function`) => `EventEmitter` |
|
|
45
|
-
| `once` | (`type`: `string`, `listener`: `Function`) => `EventEmitter` |
|
|
46
|
-
| `removeAllListeners` | (`type`: `string`) => `EventEmitter` |
|
|
47
|
-
| `setMaxListeners` | (`n`: `any`) => { on(type: string, listener: Function): EventEmitter; once(type: string, listener: Function): EventEmitter; emit(...args: any[]): any;
|
|
43
|
+
| `off` | (`type`: `string`, `listener`: `Function`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
|
|
44
|
+
| `on` | (`type`: `string`, `listener`: `Function`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
|
|
45
|
+
| `once` | (`type`: `string`, `listener`: `Function`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
|
|
46
|
+
| `removeAllListeners` | (`type`: `string`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
|
|
47
|
+
| `setMaxListeners` | (`n`: `any`) => { on(type: string, listener: Function): EventEmitter; once(type: string, listener: Function): EventEmitter; emit(...args: any[]): any; ... 5 more ...; removeAllListeners(type: string): EventEmitter; } |
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[src/default-methods.js:8](https://github.com/snowyu/events-ex.js/blob/
|
|
51
|
+
[src/default-methods.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/default-methods.js#L8)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[events-ex](../README.md) / [Exports](../modules.md) / event-emitter
|
|
2
|
+
|
|
3
|
+
# Module: event-emitter
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](event_emitter-1.md#default)
|
|
10
|
+
|
|
11
|
+
### Classes
|
|
12
|
+
|
|
13
|
+
- [EventEmitter](../classes/event_emitter-1.EventEmitter.md)
|
|
14
|
+
|
|
15
|
+
## References
|
|
16
|
+
|
|
17
|
+
### default
|
|
18
|
+
|
|
19
|
+
Renames and re-exports [EventEmitter](../classes/event_emitter-1.EventEmitter.md)
|
|
@@ -8,50 +8,12 @@
|
|
|
8
8
|
|
|
9
9
|
- [default](event_emitter.md#default)
|
|
10
10
|
|
|
11
|
-
###
|
|
11
|
+
### Classes
|
|
12
12
|
|
|
13
|
-
- [
|
|
14
|
-
|
|
15
|
-
### Functions
|
|
16
|
-
|
|
17
|
-
- [wrapEventEmitter](event_emitter.md#wrapeventemitter)
|
|
13
|
+
- [EventEmitter](../classes/event_emitter.EventEmitter.md)
|
|
18
14
|
|
|
19
15
|
## References
|
|
20
16
|
|
|
21
17
|
### default
|
|
22
18
|
|
|
23
|
-
Renames and re-exports [
|
|
24
|
-
|
|
25
|
-
## Variables
|
|
26
|
-
|
|
27
|
-
### methods
|
|
28
|
-
|
|
29
|
-
• `Const` **methods**: `any`
|
|
30
|
-
|
|
31
|
-
#### Defined in
|
|
32
|
-
|
|
33
|
-
[src/event-emitter.js:6](https://github.com/snowyu/events-ex.js/blob/892d26d/src/event-emitter.js#L6)
|
|
34
|
-
|
|
35
|
-
## Functions
|
|
36
|
-
|
|
37
|
-
### wrapEventEmitter
|
|
38
|
-
|
|
39
|
-
▸ **wrapEventEmitter**(`o?`): `any`
|
|
40
|
-
|
|
41
|
-
Create or inject the eventable instance into the object
|
|
42
|
-
|
|
43
|
-
#### Parameters
|
|
44
|
-
|
|
45
|
-
| Name | Type | Description |
|
|
46
|
-
| :------ | :------ | :------ |
|
|
47
|
-
| `o?` | `any` | the optional instance to eventable |
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
`any`
|
|
52
|
-
|
|
53
|
-
o or new Event instance
|
|
54
|
-
|
|
55
|
-
#### Defined in
|
|
56
|
-
|
|
57
|
-
[src/event-emitter.js:33](https://github.com/snowyu/events-ex.js/blob/892d26d/src/event-emitter.js#L33)
|
|
19
|
+
Renames and re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)
|
|
@@ -37,4 +37,4 @@ Renames and re-exports [hasListeners](has_listeners.md#haslisteners)
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/
|
|
40
|
+
[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/has-listeners.js#L10)
|
package/docs/modules/index.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
### References
|
|
8
8
|
|
|
9
|
+
- [Event](index.md#event)
|
|
10
|
+
- [EventEmitter](index.md#eventemitter)
|
|
9
11
|
- [allOff](index.md#alloff)
|
|
10
12
|
- [default](index.md#default)
|
|
11
13
|
- [eventable](index.md#eventable)
|
|
@@ -17,11 +19,19 @@
|
|
|
17
19
|
- [unify](index.md#unify)
|
|
18
20
|
- [wrapEventEmitter](index.md#wrapeventemitter)
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
## References
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
### Event
|
|
23
25
|
|
|
24
|
-
|
|
26
|
+
Re-exports [Event](../classes/event.Event.md)
|
|
27
|
+
|
|
28
|
+
___
|
|
29
|
+
|
|
30
|
+
### EventEmitter
|
|
31
|
+
|
|
32
|
+
Re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)
|
|
33
|
+
|
|
34
|
+
___
|
|
25
35
|
|
|
26
36
|
### allOff
|
|
27
37
|
|
|
@@ -31,7 +41,7 @@ ___
|
|
|
31
41
|
|
|
32
42
|
### default
|
|
33
43
|
|
|
34
|
-
Renames and re-exports [EventEmitter](../classes/
|
|
44
|
+
Renames and re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)
|
|
35
45
|
|
|
36
46
|
___
|
|
37
47
|
|
|
@@ -49,7 +59,7 @@ ___
|
|
|
49
59
|
|
|
50
60
|
### methods
|
|
51
61
|
|
|
52
|
-
Re-exports [methods](
|
|
62
|
+
Re-exports [methods](wrap_event_emitter.md#methods)
|
|
53
63
|
|
|
54
64
|
___
|
|
55
65
|
|
|
@@ -79,4 +89,4 @@ ___
|
|
|
79
89
|
|
|
80
90
|
### wrapEventEmitter
|
|
81
91
|
|
|
82
|
-
Re-exports [wrapEventEmitter](
|
|
92
|
+
Re-exports [wrapEventEmitter](wrap_event_emitter.md#wrapeventemitter)
|
package/docs/modules/pipe.md
CHANGED
|
@@ -34,8 +34,8 @@ Creates a pipeline between two event emitters, so that any events emitted by the
|
|
|
34
34
|
|
|
35
35
|
| Name | Type | Description |
|
|
36
36
|
| :------ | :------ | :------ |
|
|
37
|
-
| `e1` | `EventEmitter` | The first event emitter. |
|
|
38
|
-
| `e2` | `EventEmitter` | The second event emitter. |
|
|
37
|
+
| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter. |
|
|
38
|
+
| `e2` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The second event emitter. |
|
|
39
39
|
| `...args` | `any` | - |
|
|
40
40
|
|
|
41
41
|
#### Returns
|
|
@@ -46,4 +46,4 @@ Creates a pipeline between two event emitters, so that any events emitted by the
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/
|
|
49
|
+
[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/pipe.js#L21)
|
|
@@ -34,8 +34,8 @@ Creates a pipeline between two event emitters, so that any events emitted by the
|
|
|
34
34
|
|
|
35
35
|
| Name | Type | Description |
|
|
36
36
|
| :------ | :------ | :------ |
|
|
37
|
-
| `e1` | `EventEmitter` | The first event emitter. |
|
|
38
|
-
| `e2` | `EventEmitter` | The second event emitter. |
|
|
37
|
+
| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter. |
|
|
38
|
+
| `e2` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The second event emitter. |
|
|
39
39
|
| `...args` | `any` | - |
|
|
40
40
|
|
|
41
41
|
#### Returns
|
|
@@ -46,4 +46,4 @@ Creates a pipeline between two event emitters, so that any events emitted by the
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/
|
|
49
|
+
[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/pipe-async.js#L21)
|
package/docs/modules/unify.md
CHANGED
|
@@ -34,8 +34,8 @@ Unifies the event listeners of two event emitter objects so that they share the
|
|
|
34
34
|
|
|
35
35
|
| Name | Type | Description |
|
|
36
36
|
| :------ | :------ | :------ |
|
|
37
|
-
| `e1` | `EventEmitter` | The first event emitter object. |
|
|
38
|
-
| `e2` | `EventEmitter` | The second event emitter object. |
|
|
37
|
+
| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter object. |
|
|
38
|
+
| `e2` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The second event emitter object. |
|
|
39
39
|
|
|
40
40
|
#### Returns
|
|
41
41
|
|
|
@@ -43,4 +43,4 @@ Unifies the event listeners of two event emitter objects so that they share the
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/
|
|
46
|
+
[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/unify.js#L17)
|
|
@@ -36,4 +36,4 @@ Renames and re-exports [remove](util_array_remove.md#remove)
|
|
|
36
36
|
|
|
37
37
|
#### Defined in
|
|
38
38
|
|
|
39
|
-
[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/
|
|
39
|
+
[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/array-remove.js#L5)
|