velocious 1.0.619 → 1.0.621

package/build/src/testing/wait-for-event.js

@@ -1,64 +0,0 @@
-// @ts-check
-/**
- * @typedef {object} WaitForEventOptions
- * @property {number} [timeoutMs] Timeout in milliseconds (default: 5000).
- * @property {(...args: Array<ReturnType<typeof JSON.parse>>) => boolean} [filter] Only resolve when this predicate returns true for the emitted arguments.
- */
-/**
- * @typedef {object} EventEmitterLike
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} on Registers a listener.
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} off Removes a listener.
- */
-/**
- * Resolves the moment `eventName` fires on `emitter` — optionally only when `filter`
- * matches the emitted arguments — instead of sleeping a fixed duration. Rejects with a
- * timeout error if the event does not fire within `timeoutMs`. The listener is always
- * removed (on resolve and on timeout).
- *
- * Use this to await a real signal (a background job finishing, a model update, a
- * websocket message) rather than guessing a delay. To poll an arbitrary condition
- * instead of a discrete event, use awaitery's `waitFor`.
- * @param {EventEmitterLike} emitter - Event emitter exposing `on`/`off` (Node EventEmitter, eventemitter3, velocious `testEvents`, ...).
- * @param {string} eventName - The event to wait for.
- * @param {WaitForEventOptions} [options] - Options.
- * @returns {Promise<ReturnType<typeof JSON.parse>>} - Resolves with the single emitted argument, an array when the event emits multiple, or undefined when it emits none.
- */
-export default function waitForEvent(emitter, eventName, options = {}) {
-    const { timeoutMs = 5000, filter } = options;
-    return new Promise((resolve, reject) => {
-        /** @type {ReturnType<typeof setTimeout>} */
-        let timer;
-        /**
-         * Resolves the wait when a matching event fires, removing itself first. A filter
-         * that throws (e.g. it assumes an event shape an intermediate emission doesn't
-         * have) rejects immediately rather than leaving the waiter pending until timeout.
-         * @param {...ReturnType<typeof JSON.parse>} args - Emitted arguments.
-         * @returns {void}
-         */
-        const listener = (...args) => {
-            if (filter) {
-                let matched;
-                try {
-                    matched = filter(...args);
-                }
-                catch (error) {
-                    clearTimeout(timer);
-                    emitter.off(eventName, listener);
-                    reject(error);
-                    return;
-                }
-                if (!matched)
-                    return;
-            }
-            clearTimeout(timer);
-            emitter.off(eventName, listener);
-            resolve(args.length > 1 ? args : args[0]);
-        };
-        timer = setTimeout(() => {
-            emitter.off(eventName, listener);
-            reject(new Error(`Timed out after ${timeoutMs}ms waiting for event ${JSON.stringify(eventName)}`));
-        }, timeoutMs);
-        emitter.on(eventName, listener);
-    });
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2FpdC1mb3ItZXZlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdGVzdGluZy93YWl0LWZvci1ldmVudC5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxZQUFZO0FBRVo7Ozs7R0FJRztBQUVIOzs7O0dBSUc7QUFFSDs7Ozs7Ozs7Ozs7OztHQWFHO0FBQ0gsTUFBTSxDQUFDLE9BQU8sVUFBVSxZQUFZLENBQUMsT0FBTyxFQUFFLFNBQVMsRUFBRSxPQUFPLEdBQUcsRUFBRTtJQUNuRSxNQUFNLEVBQUMsU0FBUyxHQUFHLElBQUksRUFBRSxNQUFNLEVBQUMsR0FBRyxPQUFPLENBQUE7SUFFMUMsT0FBTyxJQUFJLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxNQUFNLEVBQUUsRUFBRTtRQUNyQyw0Q0FBNEM7UUFDNUMsSUFBSSxLQUFLLENBQUE7UUFFVDs7Ozs7O1dBTUc7UUFDSCxNQUFNLFFBQVEsR0FBRyxDQUFDLEdBQUcsSUFBSSxFQUFFLEVBQUU7WUFDM0IsSUFBSSxNQUFNLEVBQUUsQ0FBQztnQkFDWCxJQUFJLE9BQU8sQ0FBQTtnQkFFWCxJQUFJLENBQUM7b0JBQ0gsT0FBTyxHQUFHLE1BQU0sQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFBO2dCQUMzQixDQUFDO2dCQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7b0JBQ2YsWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFBO29CQUNuQixPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsRUFBRSxRQUFRLENBQUMsQ0FBQTtvQkFDaEMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFBO29CQUViLE9BQU07Z0JBQ1IsQ0FBQztnQkFFRCxJQUFJLENBQUMsT0FBTztvQkFBRSxPQUFNO1lBQ3RCLENBQUM7WUFFRCxZQUFZLENBQUMsS0FBSyxDQUFDLENBQUE7WUFDbkIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUUsUUFBUSxDQUFDLENBQUE7WUFDaEMsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQzNDLENBQUMsQ0FBQTtRQUVELEtBQUssR0FBRyxVQUFVLENBQUMsR0FBRyxFQUFFO1lBQ3RCLE9BQU8sQ0FBQyxHQUFHLENBQUMsU0FBUyxFQUFFLFFBQVEsQ0FBQyxDQUFBO1lBQ2hDLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxtQkFBbUIsU0FBUyx3QkFBd0IsSUFBSSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQTtRQUNwRyxDQUFDLEVBQUUsU0FBUyxDQUFDLENBQUE7UUFFYixPQUFPLENBQUMsRUFBRSxDQUFDLFNBQVMsRUFBRSxRQUFRLENBQUMsQ0FBQTtJQUNqQyxDQUFDLENBQUMsQ0FBQTtBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBAdHMtY2hlY2tcblxuLyoqXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBXYWl0Rm9yRXZlbnRPcHRpb25zXG4gKiBAcHJvcGVydHkge251bWJlcn0gW3RpbWVvdXRNc10gVGltZW91dCBpbiBtaWxsaXNlY29uZHMgKGRlZmF1bHQ6IDUwMDApLlxuICogQHByb3BlcnR5IHsoLi4uYXJnczogQXJyYXk8UmV0dXJuVHlwZTx0eXBlb2YgSlNPTi5wYXJzZT4+KSA9PiBib29sZWFufSBbZmlsdGVyXSBPbmx5IHJlc29sdmUgd2hlbiB0aGlzIHByZWRpY2F0ZSByZXR1cm5zIHRydWUgZm9yIHRoZSBlbWl0dGVkIGFyZ3VtZW50cy5cbiAqL1xuXG4vKipcbiAqIEB0eXBlZGVmIHtvYmplY3R9IEV2ZW50RW1pdHRlckxpa2VcbiAqIEBwcm9wZXJ0eSB7KGV2ZW50OiBzdHJpbmcsIGxpc3RlbmVyOiAoLi4uYXJnczogQXJyYXk8UmV0dXJuVHlwZTx0eXBlb2YgSlNPTi5wYXJzZT4+KSA9PiB2b2lkKSA9PiB2b2lkfSBvbiBSZWdpc3RlcnMgYSBsaXN0ZW5lci5cbiAqIEBwcm9wZXJ0eSB7KGV2ZW50OiBzdHJpbmcsIGxpc3RlbmVyOiAoLi4uYXJnczogQXJyYXk8UmV0dXJuVHlwZTx0eXBlb2YgSlNPTi5wYXJzZT4+KSA9PiB2b2lkKSA9PiB2b2lkfSBvZmYgUmVtb3ZlcyBhIGxpc3RlbmVyLlxuICovXG5cbi8qKlxuICogUmVzb2x2ZXMgdGhlIG1vbWVudCBgZXZlbnROYW1lYCBmaXJlcyBvbiBgZW1pdHRlcmAg4oCUIG9wdGlvbmFsbHkgb25seSB3aGVuIGBmaWx0ZXJgXG4gKiBtYXRjaGVzIHRoZSBlbWl0dGVkIGFyZ3VtZW50cyDigJQgaW5zdGVhZCBvZiBzbGVlcGluZyBhIGZpeGVkIGR1cmF0aW9uLiBSZWplY3RzIHdpdGggYVxuICogdGltZW91dCBlcnJvciBpZiB0aGUgZXZlbnQgZG9lcyBub3QgZmlyZSB3aXRoaW4gYHRpbWVvdXRNc2AuIFRoZSBsaXN0ZW5lciBpcyBhbHdheXNcbiAqIHJlbW92ZWQgKG9uIHJlc29sdmUgYW5kIG9uIHRpbWVvdXQpLlxuICpcbiAqIFVzZSB0aGlzIHRvIGF3YWl0IGEgcmVhbCBzaWduYWwgKGEgYmFja2dyb3VuZCBqb2IgZmluaXNoaW5nLCBhIG1vZGVsIHVwZGF0ZSwgYVxuICogd2Vic29ja2V0IG1lc3NhZ2UpIHJhdGhlciB0aGFuIGd1ZXNzaW5nIGEgZGVsYXkuIFRvIHBvbGwgYW4gYXJiaXRyYXJ5IGNvbmRpdGlvblxuICogaW5zdGVhZCBvZiBhIGRpc2NyZXRlIGV2ZW50LCB1c2UgYXdhaXRlcnkncyBgd2FpdEZvcmAuXG4gKiBAcGFyYW0ge0V2ZW50RW1pdHRlckxpa2V9IGVtaXR0ZXIgLSBFdmVudCBlbWl0dGVyIGV4cG9zaW5nIGBvbmAvYG9mZmAgKE5vZGUgRXZlbnRFbWl0dGVyLCBldmVudGVtaXR0ZXIzLCB2ZWxvY2lvdXMgYHRlc3RFdmVudHNgLCAuLi4pLlxuICogQHBhcmFtIHtzdHJpbmd9IGV2ZW50TmFtZSAtIFRoZSBldmVudCB0byB3YWl0IGZvci5cbiAqIEBwYXJhbSB7V2FpdEZvckV2ZW50T3B0aW9uc30gW29wdGlvbnNdIC0gT3B0aW9ucy5cbiAqIEByZXR1cm5zIHtQcm9taXNlPFJldHVyblR5cGU8dHlwZW9mIEpTT04ucGFyc2U+Pn0gLSBSZXNvbHZlcyB3aXRoIHRoZSBzaW5nbGUgZW1pdHRlZCBhcmd1bWVudCwgYW4gYXJyYXkgd2hlbiB0aGUgZXZlbnQgZW1pdHMgbXVsdGlwbGUsIG9yIHVuZGVmaW5lZCB3aGVuIGl0IGVtaXRzIG5vbmUuXG4gKi9cbmV4cG9ydCBkZWZhdWx0IGZ1bmN0aW9uIHdhaXRGb3JFdmVudChlbWl0dGVyLCBldmVudE5hbWUsIG9wdGlvbnMgPSB7fSkge1xuICBjb25zdCB7dGltZW91dE1zID0gNTAwMCwgZmlsdGVyfSA9IG9wdGlvbnNcblxuICByZXR1cm4gbmV3IFByb21pc2UoKHJlc29sdmUsIHJlamVjdCkgPT4ge1xuICAgIC8qKiBAdHlwZSB7UmV0dXJuVHlwZTx0eXBlb2Ygc2V0VGltZW91dD59ICovXG4gICAgbGV0IHRpbWVyXG5cbiAgICAvKipcbiAgICAgKiBSZXNvbHZlcyB0aGUgd2FpdCB3aGVuIGEgbWF0Y2hpbmcgZXZlbnQgZmlyZXMsIHJlbW92aW5nIGl0c2VsZiBmaXJzdC4gQSBmaWx0ZXJcbiAgICAgKiB0aGF0IHRocm93cyAoZS5nLiBpdCBhc3N1bWVzIGFuIGV2ZW50IHNoYXBlIGFuIGludGVybWVkaWF0ZSBlbWlzc2lvbiBkb2Vzbid0XG4gICAgICogaGF2ZSkgcmVqZWN0cyBpbW1lZGlhdGVseSByYXRoZXIgdGhhbiBsZWF2aW5nIHRoZSB3YWl0ZXIgcGVuZGluZyB1bnRpbCB0aW1lb3V0LlxuICAgICAqIEBwYXJhbSB7Li4uUmV0dXJuVHlwZTx0eXBlb2YgSlNPTi5wYXJzZT59IGFyZ3MgLSBFbWl0dGVkIGFyZ3VtZW50cy5cbiAgICAgKiBAcmV0dXJucyB7dm9pZH1cbiAgICAgKi9cbiAgICBjb25zdCBsaXN0ZW5lciA9ICguLi5hcmdzKSA9PiB7XG4gICAgICBpZiAoZmlsdGVyKSB7XG4gICAgICAgIGxldCBtYXRjaGVkXG5cbiAgICAgICAgdHJ5IHtcbiAgICAgICAgICBtYXRjaGVkID0gZmlsdGVyKC4uLmFyZ3MpXG4gICAgICAgIH0gY2F0Y2ggKGVycm9yKSB7XG4gICAgICAgICAgY2xlYXJUaW1lb3V0KHRpbWVyKVxuICAgICAgICAgIGVtaXR0ZXIub2ZmKGV2ZW50TmFtZSwgbGlzdGVuZXIpXG4gICAgICAgICAgcmVqZWN0KGVycm9yKVxuXG4gICAgICAgICAgcmV0dXJuXG4gICAgICAgIH1cblxuICAgICAgICBpZiAoIW1hdGNoZWQpIHJldHVyblxuICAgICAgfVxuXG4gICAgICBjbGVhclRpbWVvdXQodGltZXIpXG4gICAgICBlbWl0dGVyLm9mZihldmVudE5hbWUsIGxpc3RlbmVyKVxuICAgICAgcmVzb2x2ZShhcmdzLmxlbmd0aCA+IDEgPyBhcmdzIDogYXJnc1swXSlcbiAgICB9XG5cbiAgICB0aW1lciA9IHNldFRpbWVvdXQoKCkgPT4ge1xuICAgICAgZW1pdHRlci5vZmYoZXZlbnROYW1lLCBsaXN0ZW5lcilcbiAgICAgIHJlamVjdChuZXcgRXJyb3IoYFRpbWVkIG91dCBhZnRlciAke3RpbWVvdXRNc31tcyB3YWl0aW5nIGZvciBldmVudCAke0pTT04uc3RyaW5naWZ5KGV2ZW50TmFtZSl9YCkpXG4gICAgfSwgdGltZW91dE1zKVxuXG4gICAgZW1pdHRlci5vbihldmVudE5hbWUsIGxpc3RlbmVyKVxuICB9KVxufVxuIl19

package/build/testing/wait-for-event.js

@@ -1,72 +0,0 @@
-// @ts-check
-
-/**
- * @typedef {object} WaitForEventOptions
- * @property {number} [timeoutMs] Timeout in milliseconds (default: 5000).
- * @property {(...args: Array<ReturnType<typeof JSON.parse>>) => boolean} [filter] Only resolve when this predicate returns true for the emitted arguments.
- */
-
-/**
- * @typedef {object} EventEmitterLike
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} on Registers a listener.
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} off Removes a listener.
- */
-
-/**
- * Resolves the moment `eventName` fires on `emitter` — optionally only when `filter`
- * matches the emitted arguments — instead of sleeping a fixed duration. Rejects with a
- * timeout error if the event does not fire within `timeoutMs`. The listener is always
- * removed (on resolve and on timeout).
- *
- * Use this to await a real signal (a background job finishing, a model update, a
- * websocket message) rather than guessing a delay. To poll an arbitrary condition
- * instead of a discrete event, use awaitery's `waitFor`.
- * @param {EventEmitterLike} emitter - Event emitter exposing `on`/`off` (Node EventEmitter, eventemitter3, velocious `testEvents`, ...).
- * @param {string} eventName - The event to wait for.
- * @param {WaitForEventOptions} [options] - Options.
- * @returns {Promise<ReturnType<typeof JSON.parse>>} - Resolves with the single emitted argument, an array when the event emits multiple, or undefined when it emits none.
- */
-export default function waitForEvent(emitter, eventName, options = {}) {
-  const {timeoutMs = 5000, filter} = options
-
-  return new Promise((resolve, reject) => {
-    /** @type {ReturnType<typeof setTimeout>} */
-    let timer
-
-    /**
-     * Resolves the wait when a matching event fires, removing itself first. A filter
-     * that throws (e.g. it assumes an event shape an intermediate emission doesn't
-     * have) rejects immediately rather than leaving the waiter pending until timeout.
-     * @param {...ReturnType<typeof JSON.parse>} args - Emitted arguments.
-     * @returns {void}
-     */
-    const listener = (...args) => {
-      if (filter) {
-        let matched
-
-        try {
-          matched = filter(...args)
-        } catch (error) {
-          clearTimeout(timer)
-          emitter.off(eventName, listener)
-          reject(error)
-
-          return
-        }
-
-        if (!matched) return
-      }
-
-      clearTimeout(timer)
-      emitter.off(eventName, listener)
-      resolve(args.length > 1 ? args : args[0])
-    }
-
-    timer = setTimeout(() => {
-      emitter.off(eventName, listener)
-      reject(new Error(`Timed out after ${timeoutMs}ms waiting for event ${JSON.stringify(eventName)}`))
-    }, timeoutMs)
-
-    emitter.on(eventName, listener)
-  })
-}

package/src/testing/wait-for-event.js

@@ -1,72 +0,0 @@
-// @ts-check
-
-/**
- * @typedef {object} WaitForEventOptions
- * @property {number} [timeoutMs] Timeout in milliseconds (default: 5000).
- * @property {(...args: Array<ReturnType<typeof JSON.parse>>) => boolean} [filter] Only resolve when this predicate returns true for the emitted arguments.
- */
-
-/**
- * @typedef {object} EventEmitterLike
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} on Registers a listener.
- * @property {(event: string, listener: (...args: Array<ReturnType<typeof JSON.parse>>) => void) => void} off Removes a listener.
- */
-
-/**
- * Resolves the moment `eventName` fires on `emitter` — optionally only when `filter`
- * matches the emitted arguments — instead of sleeping a fixed duration. Rejects with a
- * timeout error if the event does not fire within `timeoutMs`. The listener is always
- * removed (on resolve and on timeout).
- *
- * Use this to await a real signal (a background job finishing, a model update, a
- * websocket message) rather than guessing a delay. To poll an arbitrary condition
- * instead of a discrete event, use awaitery's `waitFor`.
- * @param {EventEmitterLike} emitter - Event emitter exposing `on`/`off` (Node EventEmitter, eventemitter3, velocious `testEvents`, ...).
- * @param {string} eventName - The event to wait for.
- * @param {WaitForEventOptions} [options] - Options.
- * @returns {Promise<ReturnType<typeof JSON.parse>>} - Resolves with the single emitted argument, an array when the event emits multiple, or undefined when it emits none.
- */
-export default function waitForEvent(emitter, eventName, options = {}) {
-  const {timeoutMs = 5000, filter} = options
-
-  return new Promise((resolve, reject) => {
-    /** @type {ReturnType<typeof setTimeout>} */
-    let timer
-
-    /**
-     * Resolves the wait when a matching event fires, removing itself first. A filter
-     * that throws (e.g. it assumes an event shape an intermediate emission doesn't
-     * have) rejects immediately rather than leaving the waiter pending until timeout.
-     * @param {...ReturnType<typeof JSON.parse>} args - Emitted arguments.
-     * @returns {void}
-     */
-    const listener = (...args) => {
-      if (filter) {
-        let matched
-
-        try {
-          matched = filter(...args)
-        } catch (error) {
-          clearTimeout(timer)
-          emitter.off(eventName, listener)
-          reject(error)
-
-          return
-        }
-
-        if (!matched) return
-      }
-
-      clearTimeout(timer)
-      emitter.off(eventName, listener)
-      resolve(args.length > 1 ? args : args[0])
-    }
-
-    timer = setTimeout(() => {
-      emitter.off(eventName, listener)
-      reject(new Error(`Timed out after ${timeoutMs}ms waiting for event ${JSON.stringify(eventName)}`))
-    }, timeoutMs)
-
-    emitter.on(eventName, listener)
-  })
-}