@yume-chan/event 0.0.15 → 0.0.16

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.json CHANGED
@@ -1,6 +1,18 @@
1
1
  {
2
2
  "name": "@yume-chan/event",
3
3
  "entries": [
4
+ {
5
+ "version": "0.0.16",
6
+ "tag": "@yume-chan/event_v0.0.16",
7
+ "date": "Sat, 28 May 2022 03:56:37 GMT",
8
+ "comments": {
9
+ "none": [
10
+ {
11
+ "comment": "Upgrade TypeScript to 4.7.2 to enable Node.js ESM"
12
+ }
13
+ ]
14
+ }
15
+ },
4
16
  {
5
17
  "version": "0.0.15",
6
18
  "tag": "@yume-chan/event_v0.0.15",
package/CHANGELOG.md CHANGED
@@ -1,6 +1,13 @@
1
1
  # Change Log - @yume-chan/event
2
2
 
3
- This log was last generated on Mon, 02 May 2022 04:18:01 GMT and should not be manually modified.
3
+ This log was last generated on Sat, 28 May 2022 03:56:37 GMT and should not be manually modified.
4
+
5
+ ## 0.0.16
6
+ Sat, 28 May 2022 03:56:37 GMT
7
+
8
+ ### Updates
9
+
10
+ - Upgrade TypeScript to 4.7.2 to enable Node.js ESM
4
11
 
5
12
  ## 0.0.15
6
13
  Mon, 02 May 2022 04:18:01 GMT
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2020-2022 Simon Chan
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2020-2022 Simon Chan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,112 +1,112 @@
1
- # @yume-chan/event
2
-
3
- Provides a strongly-typed EventEmitter/Event implementation.
4
-
5
- Inspired by TypeScript, Visual Studio Code, and more.
6
-
7
- - [Disposable](#disposable)
8
- - [AutoDisposable](#autodisposable)
9
- - [DisposableList](#disposablelist)
10
- - [EventEmitter/Event](#eventemitterevent)
11
-
12
- ## Disposable
13
-
14
- ```ts
15
- interface Disposable {
16
- dispose(): void;
17
- }
18
- ```
19
-
20
- Represents anything that need cleanup before the garbage collector recycle it.
21
-
22
- ## AutoDisposable
23
-
24
- ```ts
25
- class AutoDisposable implements Disposable {
26
- private disposables;
27
- constructor();
28
- protected addDisposable<T extends Disposable>(disposable: T): T;
29
- dispose(): void;
30
- }
31
- ```
32
-
33
- A base class for objects that need to manage multiple `Disposable`s.
34
-
35
- Calling `dispose` on it will automatically dispose all `Disposable`s added via `addDisposable`.
36
-
37
- Usually works like:
38
-
39
- ```ts
40
- class MyObject extends AutoDisposable {
41
- private event1 = this.addDisposable(new EventEmitter<void>());
42
-
43
- private event2 = this.addDisposable(new EventEmitter<void>());
44
-
45
- public dispose() {
46
- // If the derived class has its own dispose logic
47
- // Don't forget to call super's `dispose`
48
- super.dispose();
49
-
50
- // Clean up itself.
51
- }
52
- }
53
- ```
54
-
55
- ## DisposableList
56
-
57
- ```ts
58
- class DisposableList extends AutoDisposable {
59
- add<T extends Disposable>(disposable: T): T;
60
- }
61
- ```
62
-
63
- An `AutoDisposable` that can be used alone (i.e. not as a base class).
64
-
65
- ## EventEmitter/Event
66
-
67
- ```ts
68
- interface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {
69
- (this: TThis, e: TEvent, ...args: TArgs): TResult;
70
- }
71
-
72
- interface RemoveEventListener extends Disposable {
73
- (): void;
74
- }
75
-
76
- interface Event<TEvent, TResult = unknown> {
77
- (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;
78
- <TThis, TArgs extends unknown[]>(listener: EventListener<TEvent, TThis, TArgs, TResult>, thisArg: TThis, ...args: TArgs): RemoveEventListener;
79
- }
80
-
81
- class EventEmitter<TEvent, TResult = unknown> implements Disposable {
82
- protected readonly listeners: EventListenerInfo<TEvent, TResult>[];
83
- constructor();
84
- protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener;
85
- event: Event<TEvent, TResult>;
86
- fire(e: TEvent): void;
87
- dispose(): void;
88
- }
89
-
90
- ```
91
-
92
- | | Node.js `EventEmitter` | This `EventEmitter` |
93
- | ----------------------------------- | ---------------------- | ------------------- |
94
- | Can emit multiple event types | Yes | No |
95
- | Only trusted source can emit events | No | Yes |
96
- | Strongly-typed | No | Yes |
97
-
98
- One `EventEmitter` for one event type. So for classes that have multiple event types, multiple `EventEmitter` can be created and assigned to multiple fields.
99
-
100
- Usually classes keep `EventEmitter`s private (using TypeScript's `private` modifier, or ECMAScript private field), only expose the `Event` interface (via `EventEmitter.event`).
101
-
102
- Everyone can subscribe to the event using the `Event` interface, but the event can only be emitted from the `EventEmitter` class.
103
-
104
- ```ts
105
- const emitter = new EventEmitter<void>();
106
- const subscribe = emitter.event;
107
- const unsubscribe = subscribe(() => {});
108
- emitter.fire();
109
- unsubscribe();
110
- ```
111
-
112
- The returned `unsubscribe` is both a function and a `Disposable`, so it can be used with `AutoDisposable` or `DisposableList`.
1
+ # @yume-chan/event
2
+
3
+ Provides a strongly-typed EventEmitter/Event implementation.
4
+
5
+ Inspired by TypeScript, Visual Studio Code, and more.
6
+
7
+ - [Disposable](#disposable)
8
+ - [AutoDisposable](#autodisposable)
9
+ - [DisposableList](#disposablelist)
10
+ - [EventEmitter/Event](#eventemitterevent)
11
+
12
+ ## Disposable
13
+
14
+ ```ts
15
+ interface Disposable {
16
+ dispose(): void;
17
+ }
18
+ ```
19
+
20
+ Represents anything that need cleanup before the garbage collector recycle it.
21
+
22
+ ## AutoDisposable
23
+
24
+ ```ts
25
+ class AutoDisposable implements Disposable {
26
+ private disposables;
27
+ constructor();
28
+ protected addDisposable<T extends Disposable>(disposable: T): T;
29
+ dispose(): void;
30
+ }
31
+ ```
32
+
33
+ A base class for objects that need to manage multiple `Disposable`s.
34
+
35
+ Calling `dispose` on it will automatically dispose all `Disposable`s added via `addDisposable`.
36
+
37
+ Usually works like:
38
+
39
+ ```ts
40
+ class MyObject extends AutoDisposable {
41
+ private event1 = this.addDisposable(new EventEmitter<void>());
42
+
43
+ private event2 = this.addDisposable(new EventEmitter<void>());
44
+
45
+ public dispose() {
46
+ // If the derived class has its own dispose logic
47
+ // Don't forget to call super's `dispose`
48
+ super.dispose();
49
+
50
+ // Clean up itself.
51
+ }
52
+ }
53
+ ```
54
+
55
+ ## DisposableList
56
+
57
+ ```ts
58
+ class DisposableList extends AutoDisposable {
59
+ add<T extends Disposable>(disposable: T): T;
60
+ }
61
+ ```
62
+
63
+ An `AutoDisposable` that can be used alone (i.e. not as a base class).
64
+
65
+ ## EventEmitter/Event
66
+
67
+ ```ts
68
+ interface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {
69
+ (this: TThis, e: TEvent, ...args: TArgs): TResult;
70
+ }
71
+
72
+ interface RemoveEventListener extends Disposable {
73
+ (): void;
74
+ }
75
+
76
+ interface Event<TEvent, TResult = unknown> {
77
+ (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;
78
+ <TThis, TArgs extends unknown[]>(listener: EventListener<TEvent, TThis, TArgs, TResult>, thisArg: TThis, ...args: TArgs): RemoveEventListener;
79
+ }
80
+
81
+ class EventEmitter<TEvent, TResult = unknown> implements Disposable {
82
+ protected readonly listeners: EventListenerInfo<TEvent, TResult>[];
83
+ constructor();
84
+ protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener;
85
+ event: Event<TEvent, TResult>;
86
+ fire(e: TEvent): void;
87
+ dispose(): void;
88
+ }
89
+
90
+ ```
91
+
92
+ | | Node.js `EventEmitter` | This `EventEmitter` |
93
+ | ----------------------------------- | ---------------------- | ------------------- |
94
+ | Can emit multiple event types | Yes | No |
95
+ | Only trusted source can emit events | No | Yes |
96
+ | Strongly-typed | No | Yes |
97
+
98
+ One `EventEmitter` for one event type. So for classes that have multiple event types, multiple `EventEmitter` can be created and assigned to multiple fields.
99
+
100
+ Usually classes keep `EventEmitter`s private (using TypeScript's `private` modifier, or ECMAScript private field), only expose the `Event` interface (via `EventEmitter.event`).
101
+
102
+ Everyone can subscribe to the event using the `Event` interface, but the event can only be emitted from the `EventEmitter` class.
103
+
104
+ ```ts
105
+ const emitter = new EventEmitter<void>();
106
+ const subscribe = emitter.event;
107
+ const unsubscribe = subscribe(() => {});
108
+ emitter.fire();
109
+ unsubscribe();
110
+ ```
111
+
112
+ The returned `unsubscribe` is both a function and a `Disposable`, so it can be used with `AutoDisposable` or `DisposableList`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yume-chan/event",
3
- "version": "0.0.15",
3
+ "version": "0.0.16",
4
4
  "description": "Event/EventEmitter",
5
5
  "keywords": [
6
6
  "event",
@@ -30,14 +30,14 @@
30
30
  "tslib": "^2.3.1"
31
31
  },
32
32
  "devDependencies": {
33
- "jest": "^27.5.1",
34
- "typescript": "4.7.0-beta",
33
+ "jest": "^28.1.0",
34
+ "typescript": "4.7.2",
35
35
  "@yume-chan/ts-package-builder": "^1.0.0"
36
36
  },
37
37
  "scripts": {
38
38
  "build": "build-ts-package",
39
39
  "build:watch": "build-ts-package --incremental",
40
- "test": "jest --coverage"
40
+ "//test": "jest --coverage"
41
41
  },
42
- "readme": "# @yume-chan/event\r\n\r\nProvides a strongly-typed EventEmitter/Event implementation.\r\n\r\nInspired by TypeScript, Visual Studio Code, and more.\r\n\r\n- [Disposable](#disposable)\r\n- [AutoDisposable](#autodisposable)\r\n- [DisposableList](#disposablelist)\r\n- [EventEmitter/Event](#eventemitterevent)\r\n\r\n## Disposable\r\n\r\n```ts\r\ninterface Disposable {\r\n dispose(): void;\r\n}\r\n```\r\n\r\nRepresents anything that need cleanup before the garbage collector recycle it.\r\n\r\n## AutoDisposable\r\n\r\n```ts\r\nclass AutoDisposable implements Disposable {\r\n private disposables;\r\n constructor();\r\n protected addDisposable<T extends Disposable>(disposable: T): T;\r\n dispose(): void;\r\n}\r\n```\r\n\r\nA base class for objects that need to manage multiple `Disposable`s.\r\n\r\nCalling `dispose` on it will automatically dispose all `Disposable`s added via `addDisposable`.\r\n\r\nUsually works like:\r\n\r\n```ts\r\nclass MyObject extends AutoDisposable {\r\n private event1 = this.addDisposable(new EventEmitter<void>());\r\n\r\n private event2 = this.addDisposable(new EventEmitter<void>());\r\n\r\n public dispose() {\r\n // If the derived class has its own dispose logic\r\n // Don't forget to call super's `dispose`\r\n super.dispose();\r\n\r\n // Clean up itself.\r\n }\r\n}\r\n```\r\n\r\n## DisposableList\r\n\r\n```ts\r\nclass DisposableList extends AutoDisposable {\r\n add<T extends Disposable>(disposable: T): T;\r\n}\r\n```\r\n\r\nAn `AutoDisposable` that can be used alone (i.e. not as a base class).\r\n\r\n## EventEmitter/Event\r\n\r\n```ts\r\ninterface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {\r\n (this: TThis, e: TEvent, ...args: TArgs): TResult;\r\n}\r\n\r\ninterface RemoveEventListener extends Disposable {\r\n (): void;\r\n}\r\n\r\ninterface Event<TEvent, TResult = unknown> {\r\n (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;\r\n <TThis, TArgs extends unknown[]>(listener: EventListener<TEvent, TThis, TArgs, TResult>, thisArg: TThis, ...args: TArgs): RemoveEventListener;\r\n}\r\n\r\nclass EventEmitter<TEvent, TResult = unknown> implements Disposable {\r\n protected readonly listeners: EventListenerInfo<TEvent, TResult>[];\r\n constructor();\r\n protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener;\r\n event: Event<TEvent, TResult>;\r\n fire(e: TEvent): void;\r\n dispose(): void;\r\n}\r\n\r\n```\r\n\r\n| | Node.js `EventEmitter` | This `EventEmitter` |\r\n| ----------------------------------- | ---------------------- | ------------------- |\r\n| Can emit multiple event types | Yes | No |\r\n| Only trusted source can emit events | No | Yes |\r\n| Strongly-typed | No | Yes |\r\n\r\nOne `EventEmitter` for one event type. So for classes that have multiple event types, multiple `EventEmitter` can be created and assigned to multiple fields.\r\n\r\nUsually classes keep `EventEmitter`s private (using TypeScript's `private` modifier, or ECMAScript private field), only expose the `Event` interface (via `EventEmitter.event`).\r\n\r\nEveryone can subscribe to the event using the `Event` interface, but the event can only be emitted from the `EventEmitter` class.\r\n\r\n```ts\r\nconst emitter = new EventEmitter<void>();\r\nconst subscribe = emitter.event;\r\nconst unsubscribe = subscribe(() => {});\r\nemitter.fire();\r\nunsubscribe();\r\n```\r\n\r\nThe returned `unsubscribe` is both a function and a `Disposable`, so it can be used with `AutoDisposable` or `DisposableList`.\r\n"
42
+ "readme": "# @yume-chan/event\n\nProvides a strongly-typed EventEmitter/Event implementation.\n\nInspired by TypeScript, Visual Studio Code, and more.\n\n- [Disposable](#disposable)\n- [AutoDisposable](#autodisposable)\n- [DisposableList](#disposablelist)\n- [EventEmitter/Event](#eventemitterevent)\n\n## Disposable\n\n```ts\ninterface Disposable {\n dispose(): void;\n}\n```\n\nRepresents anything that need cleanup before the garbage collector recycle it.\n\n## AutoDisposable\n\n```ts\nclass AutoDisposable implements Disposable {\n private disposables;\n constructor();\n protected addDisposable<T extends Disposable>(disposable: T): T;\n dispose(): void;\n}\n```\n\nA base class for objects that need to manage multiple `Disposable`s.\n\nCalling `dispose` on it will automatically dispose all `Disposable`s added via `addDisposable`.\n\nUsually works like:\n\n```ts\nclass MyObject extends AutoDisposable {\n private event1 = this.addDisposable(new EventEmitter<void>());\n\n private event2 = this.addDisposable(new EventEmitter<void>());\n\n public dispose() {\n // If the derived class has its own dispose logic\n // Don't forget to call super's `dispose`\n super.dispose();\n\n // Clean up itself.\n }\n}\n```\n\n## DisposableList\n\n```ts\nclass DisposableList extends AutoDisposable {\n add<T extends Disposable>(disposable: T): T;\n}\n```\n\nAn `AutoDisposable` that can be used alone (i.e. not as a base class).\n\n## EventEmitter/Event\n\n```ts\ninterface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {\n (this: TThis, e: TEvent, ...args: TArgs): TResult;\n}\n\ninterface RemoveEventListener extends Disposable {\n (): void;\n}\n\ninterface Event<TEvent, TResult = unknown> {\n (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;\n <TThis, TArgs extends unknown[]>(listener: EventListener<TEvent, TThis, TArgs, TResult>, thisArg: TThis, ...args: TArgs): RemoveEventListener;\n}\n\nclass EventEmitter<TEvent, TResult = unknown> implements Disposable {\n protected readonly listeners: EventListenerInfo<TEvent, TResult>[];\n constructor();\n protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener;\n event: Event<TEvent, TResult>;\n fire(e: TEvent): void;\n dispose(): void;\n}\n\n```\n\n| | Node.js `EventEmitter` | This `EventEmitter` |\n| ----------------------------------- | ---------------------- | ------------------- |\n| Can emit multiple event types | Yes | No |\n| Only trusted source can emit events | No | Yes |\n| Strongly-typed | No | Yes |\n\nOne `EventEmitter` for one event type. So for classes that have multiple event types, multiple `EventEmitter` can be created and assigned to multiple fields.\n\nUsually classes keep `EventEmitter`s private (using TypeScript's `private` modifier, or ECMAScript private field), only expose the `Event` interface (via `EventEmitter.event`).\n\nEveryone can subscribe to the event using the `Event` interface, but the event can only be emitted from the `EventEmitter` class.\n\n```ts\nconst emitter = new EventEmitter<void>();\nconst subscribe = emitter.event;\nconst unsubscribe = subscribe(() => {});\nemitter.fire();\nunsubscribe();\n```\n\nThe returned `unsubscribe` is both a function and a `Disposable`, so it can be used with `AutoDisposable` or `DisposableList`.\n"
43
43
  }
package/src/disposable.ts CHANGED
@@ -1,30 +1,30 @@
1
- export interface Disposable {
2
- dispose(): void;
3
- }
4
-
5
- export class AutoDisposable implements Disposable {
6
- private disposables: Disposable[] = [];
7
-
8
- public constructor() {
9
- this.dispose = this.dispose.bind(this);
10
- }
11
-
12
- protected addDisposable<T extends Disposable>(disposable: T): T {
13
- this.disposables.push(disposable);
14
- return disposable;
15
- }
16
-
17
- public dispose() {
18
- for (const disposable of this.disposables) {
19
- disposable.dispose();
20
- }
21
-
22
- this.disposables = [];
23
- }
24
- }
25
-
26
- export class DisposableList extends AutoDisposable {
27
- public add<T extends Disposable>(disposable: T): T {
28
- return this.addDisposable(disposable);
29
- }
30
- }
1
+ export interface Disposable {
2
+ dispose(): void;
3
+ }
4
+
5
+ export class AutoDisposable implements Disposable {
6
+ private disposables: Disposable[] = [];
7
+
8
+ public constructor() {
9
+ this.dispose = this.dispose.bind(this);
10
+ }
11
+
12
+ protected addDisposable<T extends Disposable>(disposable: T): T {
13
+ this.disposables.push(disposable);
14
+ return disposable;
15
+ }
16
+
17
+ public dispose() {
18
+ for (const disposable of this.disposables) {
19
+ disposable.dispose();
20
+ }
21
+
22
+ this.disposables = [];
23
+ }
24
+ }
25
+
26
+ export class DisposableList extends AutoDisposable {
27
+ public add<T extends Disposable>(disposable: T): T {
28
+ return this.addDisposable(disposable);
29
+ }
30
+ }
@@ -1,62 +1,62 @@
1
- import type { Disposable } from './disposable.js';
2
- import type { EventListener, RemoveEventListener } from './event.js';
3
-
4
- export interface EventListenerInfo<TEvent, TResult = unknown> {
5
- listener: EventListener<TEvent, any, any, TResult>;
6
-
7
- thisArg: unknown;
8
-
9
- args: unknown[];
10
- }
11
-
12
- export class EventEmitter<TEvent, TResult = unknown> implements Disposable {
13
- protected readonly listeners: EventListenerInfo<TEvent, TResult>[] = [];
14
-
15
- public constructor() {
16
- this.event = this.event.bind(this);
17
- }
18
-
19
- protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener {
20
- this.listeners.push(info);
21
-
22
- const remove: RemoveEventListener = () => {
23
- const index = this.listeners.indexOf(info);
24
- if (index !== -1) {
25
- this.listeners.splice(index, 1);
26
- }
27
- };
28
- remove.dispose = remove;
29
- return remove;
30
- }
31
-
32
- public event(
33
- listener: EventListener<TEvent, unknown, [], TResult>
34
- ): RemoveEventListener;
35
- public event<TThis, TArgs extends unknown[]>(
36
- listener: EventListener<TEvent, TThis, TArgs, TResult>,
37
- thisArg: TThis,
38
- ...args: TArgs
39
- ): RemoveEventListener;
40
- public event<TThis, TArgs extends unknown[]>(
41
- listener: EventListener<TEvent, TThis, TArgs, TResult>,
42
- thisArg?: TThis,
43
- ...args: TArgs
44
- ): RemoveEventListener {
45
- const info: EventListenerInfo<TEvent, TResult> = {
46
- listener,
47
- thisArg,
48
- args,
49
- };
50
- return this.addEventListener(info);
51
- }
52
-
53
- public fire(e: TEvent) {
54
- for (const info of this.listeners.slice()) {
55
- info.listener.apply(info.thisArg, [e, ...info.args]);
56
- }
57
- }
58
-
59
- public dispose() {
60
- this.listeners.length = 0;
61
- }
62
- }
1
+ import type { Disposable } from './disposable.js';
2
+ import type { EventListener, RemoveEventListener } from './event.js';
3
+
4
+ export interface EventListenerInfo<TEvent, TResult = unknown> {
5
+ listener: EventListener<TEvent, any, any, TResult>;
6
+
7
+ thisArg: unknown;
8
+
9
+ args: unknown[];
10
+ }
11
+
12
+ export class EventEmitter<TEvent, TResult = unknown> implements Disposable {
13
+ protected readonly listeners: EventListenerInfo<TEvent, TResult>[] = [];
14
+
15
+ public constructor() {
16
+ this.event = this.event.bind(this);
17
+ }
18
+
19
+ protected addEventListener(info: EventListenerInfo<TEvent, TResult>): RemoveEventListener {
20
+ this.listeners.push(info);
21
+
22
+ const remove: RemoveEventListener = () => {
23
+ const index = this.listeners.indexOf(info);
24
+ if (index !== -1) {
25
+ this.listeners.splice(index, 1);
26
+ }
27
+ };
28
+ remove.dispose = remove;
29
+ return remove;
30
+ }
31
+
32
+ public event(
33
+ listener: EventListener<TEvent, unknown, [], TResult>
34
+ ): RemoveEventListener;
35
+ public event<TThis, TArgs extends unknown[]>(
36
+ listener: EventListener<TEvent, TThis, TArgs, TResult>,
37
+ thisArg: TThis,
38
+ ...args: TArgs
39
+ ): RemoveEventListener;
40
+ public event<TThis, TArgs extends unknown[]>(
41
+ listener: EventListener<TEvent, TThis, TArgs, TResult>,
42
+ thisArg?: TThis,
43
+ ...args: TArgs
44
+ ): RemoveEventListener {
45
+ const info: EventListenerInfo<TEvent, TResult> = {
46
+ listener,
47
+ thisArg,
48
+ args,
49
+ };
50
+ return this.addEventListener(info);
51
+ }
52
+
53
+ public fire(e: TEvent) {
54
+ for (const info of this.listeners.slice()) {
55
+ info.listener.apply(info.thisArg, [e, ...info.args]);
56
+ }
57
+ }
58
+
59
+ public dispose() {
60
+ this.listeners.length = 0;
61
+ }
62
+ }
package/src/event.ts CHANGED
@@ -1,25 +1,25 @@
1
- import type { Disposable } from './disposable.js';
2
-
3
- export interface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {
4
- (this: TThis, e: TEvent, ...args: TArgs): TResult;
5
- }
6
-
7
- export interface RemoveEventListener extends Disposable {
8
- (): void;
9
- }
10
-
11
- export interface Event<TEvent, TResult = unknown> {
12
- /**
13
- * Attaches an event listener.
14
- */
15
- (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;
16
-
17
- /**
18
- * Attaches an event listener that bind to `this` and `args`.
19
- */
20
- <TThis, TArgs extends unknown[]>(
21
- listener: EventListener<TEvent, TThis, TArgs, TResult>,
22
- thisArg: TThis,
23
- ...args: TArgs
24
- ): RemoveEventListener;
25
- }
1
+ import type { Disposable } from './disposable.js';
2
+
3
+ export interface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {
4
+ (this: TThis, e: TEvent, ...args: TArgs): TResult;
5
+ }
6
+
7
+ export interface RemoveEventListener extends Disposable {
8
+ (): void;
9
+ }
10
+
11
+ export interface Event<TEvent, TResult = unknown> {
12
+ /**
13
+ * Attaches an event listener.
14
+ */
15
+ (listener: EventListener<TEvent, unknown, [], TResult>): RemoveEventListener;
16
+
17
+ /**
18
+ * Attaches an event listener that bind to `this` and `args`.
19
+ */
20
+ <TThis, TArgs extends unknown[]>(
21
+ listener: EventListener<TEvent, TThis, TArgs, TResult>,
22
+ thisArg: TThis,
23
+ ...args: TArgs
24
+ ): RemoveEventListener;
25
+ }
package/src/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- export * from './disposable.js';
2
- export * from './event.js';
3
- export * from './event-emitter.js';
4
- export * from './utils.js';
1
+ export * from './disposable.js';
2
+ export * from './event.js';
3
+ export * from './event-emitter.js';
4
+ export * from './utils.js';
package/src/utils.ts CHANGED
@@ -1,10 +1,10 @@
1
- import { PromiseResolver } from '@yume-chan/async';
2
- import type { Event } from './event.js';
3
-
4
- export async function once<T>(event: Event<T, any>): Promise<T> {
5
- const resolver = new PromiseResolver<T>();
6
- const dispose = event(resolver.resolve);
7
- const result = await resolver.promise;
8
- dispose();
9
- return result;
10
- }
1
+ import { PromiseResolver } from '@yume-chan/async';
2
+ import type { Event } from './event.js';
3
+
4
+ export async function once<T>(event: Event<T, any>): Promise<T> {
5
+ const resolver = new PromiseResolver<T>();
6
+ const dispose = event(resolver.resolve);
7
+ const result = await resolver.promise;
8
+ dispose();
9
+ return result;
10
+ }