@yume-chan/event - npm Package Compare versions

Comparing version 0.0.10 to 0.0.12

CHANGELOG.json

@@ -5,2 +5,23 @@ {
     {
+      "version": "0.0.12",
+      "tag": "@yume-chan/event_v0.0.12",
+      "date": "Sun, 03 Apr 2022 11:18:47 GMT",
+      "comments": {}
+    },
+    {
+      "version": "0.0.11",
+      "tag": "@yume-chan/event_v0.0.11",
+      "date": "Sun, 03 Apr 2022 11:18:11 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Improve compatibility with Node.js 12 ESM format"
+          },
+          {
+            "comment": "Update license year"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.0.10",
@@ -7,0 +28,0 @@ "tag": "@yume-chan/event_v0.0.10",

CHANGELOG.md

 # Change Log - @yume-chan/event
 
-This log was last generated on Sun, 09 Jan 2022 15:52:20 GMT and should not be manually modified.
+This log was last generated on Sun, 03 Apr 2022 11:18:47 GMT and should not be manually modified.
 
+## 0.0.12
+Sun, 03 Apr 2022 11:18:47 GMT
+
+_Version update only_
+
+## 0.0.11
+Sun, 03 Apr 2022 11:18:11 GMT
+
+### Updates
+
+- Improve compatibility with Node.js 12 ESM format
+- Update license year
+
 ## 0.0.10
@@ -6,0 +19,0 @@ Sun, 09 Jan 2022 15:52:20 GMT

esm/disposable.js

 export class AutoDisposable {
+    disposables = [];
     constructor() {
-        this.disposables = [];
         this.dispose = this.dispose.bind(this);
@@ -5,0 +5,0 @@ }

esm/event-emitter.js

 export class EventEmitter {
+    listeners = [];
     constructor() {
-        this.listeners = [];
         this.event = this.event.bind(this);
@@ -5,0 +5,0 @@ }

esm/index.js

@@ -1,5 +0,5 @@
-export * from './disposable';
-export * from './event';
-export * from './event-emitter';
-export * from './utils';
+export * from './disposable.js';
+export * from './event.js';
+export * from './event-emitter.js';
+export * from './utils.js';
 //# sourceMappingURL=index.js.map

esm/utils.js

@@ -1,12 +0,9 @@
-import { __awaiter } from "tslib";
 import { PromiseResolver } from '@yume-chan/async';
-export function once(event) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const resolver = new PromiseResolver();
-        const dispose = event(resolver.resolve);
-        const result = yield resolver.promise;
-        dispose();
-        return result;
-    });
+export async function once(event) {
+    const resolver = new PromiseResolver();
+    const dispose = event(resolver.resolve);
+    const result = await resolver.promise;
+    dispose();
+    return result;
 }
 //# sourceMappingURL=utils.js.map

package.json

 {
-    "name": "@yume-chan/event",
-    "version": "0.0.10",
-    "description": "Event/EventEmitter",
-    "keywords": [
-        "event",
-        "eventemitter",
-        "typescript"
-    ],
-    "license": "MIT",
-    "author": {
-        "name": "Simon Chan",
-        "email": "[e-mail]",
-        "url": "https://chensi.moe/blog"
-    },
-    "homepage": "https://github.com/yume-chan/ya-webadb/tree/master/libraries/event#readme",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/yume-chan/ya-webadb.git",
-        "directory": "libraries/event"
-    },
-    "bugs": {
-        "url": "https://github.com/yume-chan/ya-webadb/issues"
-    },
-    "type": "module",
-    "module": "esm/index.js",
-    "types": "dts/index.d.ts",
-    "scripts": {
-        "build": "build-ts-package",
-        "build:watch": "build-ts-package --incremental",
-        "test": "jest --coverage",
-        "prepublishOnly": "npm run build"
-    },
-    "dependencies": {
-        "@yume-chan/async": "^2.1.4",
-        "tslib": "^2.3.1"
-    },
-    "devDependencies": {
-        "jest": "^26.6.3",
-        "typescript": "^4.5.4",
-        "@yume-chan/ts-package-builder": "^1.0.0"
-    }
-}
+  "name": "@yume-chan/event",
+  "version": "0.0.12",
+  "description": "Event/EventEmitter",
+  "keywords": [
+    "event",
+    "eventemitter",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Simon Chan",
+    "email": "[e-mail]",
+    "url": "https://chensi.moe/blog"
+  },
+  "homepage": "https://github.com/yume-chan/ya-webadb/tree/master/libraries/event#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yume-chan/ya-webadb.git",
+    "directory": "libraries/event"
+  },
+  "bugs": {
+    "url": "https://github.com/yume-chan/ya-webadb/issues"
+  },
+  "type": "module",
+  "main": "esm/index.js",
+  "types": "esm/index.d.ts",
+  "dependencies": {
+    "@yume-chan/async": "^2.1.4",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "jest": "^27.5.1",
+    "typescript": "next",
+    "@yume-chan/ts-package-builder": "^1.0.0"
+  },
+  "scripts": {
+    "build": "build-ts-package",
+    "build:watch": "build-ts-package --incremental",
+    "test": "jest --coverage"
+  },
+  "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"
+}

src/event-emitter.ts

@@ -1,3 +0,3 @@
-import { Disposable } from './disposable';
-import { EventListener, RemoveEventListener } from './event';
+import type { Disposable } from './disposable.js';
+import type { EventListener, RemoveEventListener } from './event.js';
 
@@ -4,0 +4,0 @@ export interface EventListenerInfo<TEvent, TResult = unknown> {

src/event.ts

@@ -1,2 +0,2 @@
-import { Disposable } from './disposable';
+import type { Disposable } from './disposable.js';
 
@@ -3,0 +3,0 @@ export interface EventListener<TEvent, TThis, TArgs extends unknown[], TResult> {

src/index.ts

@@ -1,4 +0,4 @@
-export * from './disposable';
-export * from './event';
-export * from './event-emitter';
-export * from './utils';
+export * from './disposable.js';
+export * from './event.js';
+export * from './event-emitter.js';
+export * from './utils.js';

src/utils.ts

 import { PromiseResolver } from '@yume-chan/async';
-import { Event } from './event';
+import type { Event } from './event.js';
 
-export async function once<T>(event: Event<T>): Promise<T> {
+export async function once<T>(event: Event<T, any>): Promise<T> {
     const resolver = new PromiseResolver<T>();
@@ -6,0 +6,0 @@ const dispose = event(resolver.resolve);

No alert changes

Improved metrics

Total package byte prevSize

23781

increased by22.12%

Lines of code

266

increased by7.26%

No dependency changes