@ixfx/events 0.38.0 → 0.39.0

package/README.md

@@ -0,0 +1,28 @@
+A simple eventing implementation.
+
+For a class, extend `SimpleEventEmitter`.
+
+```typescript
+export type MyClassEvents = {
+  // An event named `blah` that has one field, 'id'.
+  readonly blah: (id:string);
+};
+
+export class MyClass extends SimpleEventEmitter<MyClassEvents> {
+
+  test() {
+    // Eg: firing an event
+     this.fireEvent(`blah`, {
+      id: Math.random()
+    });
+  }
+}
+```
+
+You can then un/subscribe as usual:
+```js
+const c = new MyClass();
+c.addEventListener(`blah`, (id) => {
+  // Event!
+});
+```

package/dist/src/index.d.ts

@@ -1,4 +1,3 @@
-export * from './race.js';
 export { SimpleEventEmitter } from './simple-event-emitter.js';
 export * from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,cAAc,YAAY,CAAC"}

package/dist/src/index.js

@@ -1,3 +1,2 @@
-export * from './race.js';
 export { SimpleEventEmitter } from './simple-event-emitter.js';
 export * from './types.js';

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/index.ts","../src/map-of.ts","../src/race.ts","../src/simple-event-emitter.ts","../src/types.ts","../__tests__/test.ts"],"version":"5.8.3"}
+{"root":["../src/index.ts","../src/map-of.ts","../src/simple-event-emitter.ts","../src/types.ts","../__tests__/test.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixfx/events",
-  "version": "0.38.0",
+  "version": "0.39.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,

package/dist/src/race.d.ts

@@ -1,23 +0,0 @@
-/**
- * Subscribes to events on `target`, returning the event data
- * from the first event that fires.
- *
- * By default waits a maximum of 1 minute.
- *
- * Automatically unsubscribes on success or failure (ie. timeout)
- *
- * ```js
- * // Event will be data from either event, whichever fires first
- * // Exception is thrown if neither fires within 1 second
- * const event = await eventRace(document.body, [`pointermove`, `pointerdown`], { timeout: 1000 });
- * ```
- * @param target Event source
- * @param eventNames Event name(s)
- * @param options Options
- * @returns
- */
-export declare const eventRace: (target: EventTarget, eventNames: Array<string>, options?: Partial<{
-    timeoutMs: number;
-    signal: AbortSignal;
-}>) => Promise<Event>;
-//# sourceMappingURL=race.d.ts.map

package/dist/src/race.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"race.d.ts","sourceRoot":"","sources":["../../src/race.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,WAAW,EAAE,YAAY,KAAK,CAAC,MAAM,CAAC,EAAE,UAAS,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,CAAM,mBAmD1I,CAAA"}

package/dist/src/race.js

@@ -1,70 +0,0 @@
-/**
- * Subscribes to events on `target`, returning the event data
- * from the first event that fires.
- *
- * By default waits a maximum of 1 minute.
- *
- * Automatically unsubscribes on success or failure (ie. timeout)
- *
- * ```js
- * // Event will be data from either event, whichever fires first
- * // Exception is thrown if neither fires within 1 second
- * const event = await eventRace(document.body, [`pointermove`, `pointerdown`], { timeout: 1000 });
- * ```
- * @param target Event source
- * @param eventNames Event name(s)
- * @param options Options
- * @returns
- */
-export const eventRace = (target, eventNames, options = {}) => {
-    const intervalMs = options.timeoutMs ?? 60_1000; //intervalToMs(options.timeout, 60 * 1000);
-    const signal = options.signal;
-    let triggered = false;
-    let disposed = false;
-    let timeout;
-    const promise = new Promise((resolve, reject) => {
-        const onEvent = (event) => {
-            if (`type` in event) {
-                if (eventNames.includes(event.type)) {
-                    triggered = true;
-                    resolve(event);
-                    dispose();
-                }
-                else {
-                    console.warn(`eventRace: Got event '${event.type}' that is not in race list`);
-                }
-            }
-            else {
-                console.warn(`eventRace: Event data does not have expected 'type' field`);
-                console.log(event);
-            }
-        };
-        for (const name of eventNames) {
-            target.addEventListener(name, onEvent);
-        }
-        const dispose = () => {
-            if (disposed)
-                return;
-            if (timeout !== undefined)
-                clearTimeout(timeout);
-            timeout = undefined;
-            disposed = true;
-            for (const name of eventNames) {
-                target.removeEventListener(name, onEvent);
-            }
-        };
-        timeout = setTimeout(() => {
-            if (triggered || disposed)
-                return;
-            dispose();
-            reject(new Error(`eventRace: Events not fired within interval. Events: ${JSON.stringify(eventNames)} Interval: ${intervalMs}`));
-        }, intervalMs);
-        signal?.addEventListener(`abort`, () => {
-            if (triggered || disposed)
-                return;
-            dispose();
-            reject(new Error(`Abort signal received ${signal.reason}`));
-        });
-    });
-    return promise;
-};