websocket-ts 2.2.1 → 3.0.0

package/dist/{esm/src → cjs}/websocket_builder.d.ts

@@ -1,7 +1,7 @@
-import { Backoff } from "./backoff/backoff";
-import { WebsocketEvent, WebsocketEventListener, WebsocketEventListenerOptions } from "./websocket_event";
-import { Websocket } from "./websocket";
-import { WebsocketBuffer } from "./websocket_buffer";
+import { Backoff } from "./backoff/backoff.js";
+import { WebsocketEvent, WebsocketEventListener, WebsocketEventListenerOptions } from "./websocket_event.js";
+import { UrlProvider, Websocket } from "./websocket.js";
+import { WebsocketBuffer } from "./websocket_buffer.js";
 /**
  * Builder for websockets.
  */
@@ -12,15 +12,15 @@ export declare class WebsocketBuilder {
     /**
      * Creates a new WebsocketBuilder.
      *
-     * @param url the url to connect to
+     * @param url the url to connect to, or a function that returns a URL
      */
-    constructor(url: string);
+    constructor(url: UrlProvider);
     /**
      * Getter for the url.
      *
-     * @returns the url
+     * @returns the url or url provider
      */
-    get url(): string;
+    get url(): UrlProvider;
     /**
      * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
      *
@@ -34,7 +34,8 @@ export declare class WebsocketBuilder {
      */
     get protocols(): string | string[] | undefined;
     /**
-     * Sets the maximum number of retries before giving up. No limit if undefined.
+     * Sets the maximum number of retries before giving up. No limit if undefined or Infinity.
+     * Must be Infinity or a non-negative integer, otherwise build() will throw.
      *
      * @param maxRetries the maximum number of retries before giving up
      */
@@ -46,15 +47,15 @@ export declare class WebsocketBuilder {
      */
     get maxRetries(): number | undefined;
     /**
-     * Sets wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     * Sets whether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
      *
-     * @param instantReconnect wether to reconnect immediately after a connection has been lost
+     * @param instantReconnect whether to reconnect immediately after a connection has been lost
      */
     withInstantReconnect(instantReconnect: boolean | undefined): WebsocketBuilder;
     /**
-     * Getter for wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     * Getter for whether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
      *
-     * @returns wether to reconnect immediately after a connection has been lost, undefined if no value has been set
+     * @returns whether to reconnect immediately after a connection has been lost, undefined if no value has been set
      */
     get instantReconnect(): boolean | undefined;
     /**
@@ -129,6 +130,14 @@ export declare class WebsocketBuilder {
      * @param options the listener options
      */
     onReconnect(listener: WebsocketEventListener<WebsocketEvent.reconnect>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'exhausted' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onExhausted(listener: WebsocketEventListener<WebsocketEvent.exhausted>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
     /**
      * Builds the websocket.
      *

package/dist/cjs/websocket_builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.d.ts","sourceRoot":"","sources":["../../src/websocket_builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,6BAA6B,EAC9B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAc;IAEnC,OAAO,CAAC,UAAU,CAAC,CAAoB;IACvC,OAAO,CAAC,QAAQ,CAAC,CAAmB;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,WAAW;IAI5B;;;;OAIG;IACH,IAAI,GAAG,IAAI,WAAW,CAErB;IAED;;;;OAIG;IACI,aAAa,CAClB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GACvC,gBAAgB;IAKnB;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAE7C;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB;IAQvE;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;;OAIG;IACI,oBAAoB,CACzB,gBAAgB,EAAE,OAAO,GAAG,SAAS,GACpC,gBAAgB;IAQnB;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,OAAO,GAAG,SAAS,CAE1C;IAED;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,gBAAgB;IAQlE;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB;IAKxE;;;;OAIG;IACH,IAAI,MAAM,IAAI,eAAe,GAAG,SAAS,CAExC;IAED;;;;;;OAMG;IACI,MAAM,CACX,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,EACrD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,SAAS,CACd,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,OAAO,CAAC,EACxD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,WAAW,CAChB,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,SAAS,CAAC,EAC1D,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,WAAW,CAChB,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,SAAS,CAAC,EAC1D,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;OAIG;IACI,KAAK,IAAI,SAAS;IAIzB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAiBpB"}

package/dist/cjs/websocket_builder.js

@@ -0,0 +1,236 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketBuilder = void 0;
+const websocket_event_js_1 = require("./websocket_event.js");
+const websocket_js_1 = require("./websocket.js");
+/**
+ * Builder for websockets.
+ */
+class WebsocketBuilder {
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to, or a function that returns a URL
+     */
+    constructor(url) {
+        this._url = url;
+    }
+    /**
+     * Getter for the url.
+     *
+     * @returns the url or url provider
+     */
+    get url() {
+        return this._url;
+    }
+    /**
+     * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
+     *
+     * @param protocols the protocols to add
+     */
+    withProtocols(protocols) {
+        this._protocols = protocols;
+        return this;
+    }
+    /**
+     * Getter for the protocols.
+     *
+     * @returns the protocols, undefined if no protocols have been set
+     */
+    get protocols() {
+        return this._protocols;
+    }
+    /**
+     * Sets the maximum number of retries before giving up. No limit if undefined or Infinity.
+     * Must be Infinity or a non-negative integer, otherwise build() will throw.
+     *
+     * @param maxRetries the maximum number of retries before giving up
+     */
+    withMaxRetries(maxRetries) {
+        var _a;
+        this._options = {
+            ...this._options,
+            retry: { ...(_a = this._options) === null || _a === void 0 ? void 0 : _a.retry, maxRetries },
+        };
+        return this;
+    }
+    /**
+     * Getter for the maximum number of retries before giving up.
+     *
+     * @returns the maximum number of retries before giving up, undefined if no maximum has been set
+     */
+    get maxRetries() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.maxRetries;
+    }
+    /**
+     * Sets whether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     *
+     * @param instantReconnect whether to reconnect immediately after a connection has been lost
+     */
+    withInstantReconnect(instantReconnect) {
+        var _a;
+        this._options = {
+            ...this._options,
+            retry: { ...(_a = this._options) === null || _a === void 0 ? void 0 : _a.retry, instantReconnect },
+        };
+        return this;
+    }
+    /**
+     * Getter for whether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     *
+     * @returns whether to reconnect immediately after a connection has been lost, undefined if no value has been set
+     */
+    get instantReconnect() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.instantReconnect;
+    }
+    /**
+     * Adds a backoff to the websocket. Subsequent calls to this method will override the previously set backoff.
+     *
+     * @param backoff the backoff to add
+     */
+    withBackoff(backoff) {
+        var _a;
+        this._options = {
+            ...this._options,
+            retry: { ...(_a = this._options) === null || _a === void 0 ? void 0 : _a.retry, backoff },
+        };
+        return this;
+    }
+    /**
+     * Getter for the backoff.
+     *
+     * @returns the backoff, undefined if no backoff has been set
+     */
+    get backoff() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.backoff;
+    }
+    /**
+     * Adds a buffer to the websocket. Subsequent calls to this method will override the previously set buffer.
+     *
+     * @param buffer the buffer to add
+     */
+    withBuffer(buffer) {
+        this._options = { ...this._options, buffer };
+        return this;
+    }
+    /**
+     * Getter for the buffer.
+     *
+     * @returns the buffer, undefined if no buffer has been set
+     */
+    get buffer() {
+        var _a;
+        return (_a = this._options) === null || _a === void 0 ? void 0 : _a.buffer;
+    }
+    /**
+     * Adds an 'open' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onOpen(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.open, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'close' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onClose(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.close, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'error' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onError(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.error, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'message' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onMessage(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.message, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'retry' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onRetry(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.retry, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'reconnect' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onReconnect(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.reconnect, listener, options);
+        return this;
+    }
+    /**
+     * Adds an 'exhausted' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onExhausted(listener, options) {
+        this.addListener(websocket_event_js_1.WebsocketEvent.exhausted, listener, options);
+        return this;
+    }
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    build() {
+        return new websocket_js_1.Websocket(this._url, this._protocols, this._options); // instantiate the websocket with the set options
+    }
+    /**
+     * Adds an event listener to the options.
+     *
+     * @param event the event to add the listener to
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    addListener(event, listener, options) {
+        var _a, _b, _c, _d;
+        this._options = {
+            ...this._options,
+            listeners: {
+                ...(_a = this._options) === null || _a === void 0 ? void 0 : _a.listeners,
+                [event]: [
+                    ...((_d = (_c = (_b = this._options) === null || _b === void 0 ? void 0 : _b.listeners) === null || _c === void 0 ? void 0 : _c[event]) !== null && _d !== void 0 ? _d : []),
+                    { listener, options },
+                ],
+            },
+        };
+        return this;
+    }
+}
+exports.WebsocketBuilder = WebsocketBuilder;
+//# sourceMappingURL=websocket_builder.js.map

package/dist/cjs/websocket_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.js","sourceRoot":"","sources":["../../src/websocket_builder.ts"],"names":[],"mappings":";;;AACA,6DAI8B;AAC9B,iDAAwD;AAIxD;;GAEG;AACH,MAAa,gBAAgB;IAM3B;;;;OAIG;IACH,YAAY,GAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAClB,SAAwC;QAExC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAA8B;;QAClD,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,IAAI,CAAC,QAAQ;YAChB,KAAK,EAAE,EAAE,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,EAAE,UAAU,EAAE;SAC/C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;;QACZ,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,UAAU,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CACzB,gBAAqC;;QAErC,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,IAAI,CAAC,QAAQ;YAChB,KAAK,EAAE,EAAE,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,EAAE,gBAAgB,EAAE;SACrD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;;QAClB,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,gBAAgB,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,OAA4B;;QAC7C,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,IAAI,CAAC,QAAQ;YAChB,KAAK,EAAE,EAAE,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,EAAE,OAAO,EAAE;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;;QACT,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAmC;QACnD,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;;QACR,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CACX,QAAqD,EACrD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACd,QAAwD,EACxD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAChB,QAA0D,EAC1D,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAChB,QAA0D,EAC1D,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,mCAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,OAAO,IAAI,wBAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iDAAiD;IACpH,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CACjB,KAAQ,EACR,QAAmC,EACnC,OAAuC;;QAEvC,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS,EAAE;gBACT,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS;gBAC3B,CAAC,KAAK,CAAC,EAAE;oBACP,GAAG,CAAC,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAG,KAAK,CAAC,mCAAI,EAAE,CAAC;oBAC5C,EAAE,QAAQ,EAAE,OAAO,EAAE;iBACtB;aACF;SACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/QD,4CA+QC"}

package/dist/cjs/websocket_event.d.ts

@@ -0,0 +1,93 @@
+import { Websocket } from "./websocket.js";
+/**
+ * Events that can be fired by the websocket.
+ */
+export declare const WebsocketEvent: {
+    /** Fired when the connection is opened. */
+    readonly open: "open";
+    /** Fired when the connection is closed. */
+    readonly close: "close";
+    /**
+     * Fired when the connection has been closed because of an error, such as when some data couldn't be sent.
+     * Also fired when an automatic retry fails because the URL provider or the WebSocket constructor threw;
+     * that event is an ErrorEvent whose 'error' is the thrown value.
+     */
+    readonly error: "error";
+    /** Fired when a message is received. */
+    readonly message: "message";
+    /** Fired when the websocket tries to reconnect after a connection loss. */
+    readonly retry: "retry";
+    /** Fired when the websocket successfully reconnects after a connection loss. */
+    readonly reconnect: "reconnect";
+    /** Fired when the websocket gives up reconnecting after exceeding maxRetries. */
+    readonly exhausted: "exhausted";
+};
+/** Union of all event type strings, allowing plain strings like "open" as event types. */
+export type WebsocketEvent = (typeof WebsocketEvent)[keyof typeof WebsocketEvent];
+/** Provides member types (e.g. WebsocketEvent.open) for use as generic type arguments. */
+export declare namespace WebsocketEvent {
+    type open = typeof WebsocketEvent.open;
+    type close = typeof WebsocketEvent.close;
+    type error = typeof WebsocketEvent.error;
+    type message = typeof WebsocketEvent.message;
+    type retry = typeof WebsocketEvent.retry;
+    type reconnect = typeof WebsocketEvent.reconnect;
+    type exhausted = typeof WebsocketEvent.exhausted;
+}
+/***
+ * Details/properties of a retry-event.
+ */
+export type RetryEventDetail = {
+    /** Number of retries that have been made since the connection was lost. */
+    readonly retries: number;
+    /** Time (ms) waited since the last connection-retry. */
+    readonly backoff: number;
+    /** Timestamp of the last successful connection ('open' event) or undefined if the connection has never been established. */
+    readonly lastConnection: Date | undefined;
+};
+/**
+ * Properties of a reconnect-event.
+ */
+export type ReconnectEventDetail = Omit<RetryEventDetail, "backoff">;
+/**
+ * Properties of an exhausted-event. The 'retries' field holds the number of
+ * retries that were performed before giving up, i.e. the configured maxRetries.
+ */
+export type ExhaustedEventDetail = Omit<RetryEventDetail, "backoff">;
+/**
+ * Maps websocket events to their corresponding event.
+ */
+export type WebsocketEventMap = {
+    [WebsocketEvent.open]: Event;
+    [WebsocketEvent.close]: CloseEvent;
+    [WebsocketEvent.error]: Event;
+    [WebsocketEvent.message]: MessageEvent;
+    [WebsocketEvent.retry]: CustomEvent<RetryEventDetail>;
+    [WebsocketEvent.reconnect]: CustomEvent<ReconnectEventDetail>;
+    [WebsocketEvent.exhausted]: CustomEvent<ExhaustedEventDetail>;
+};
+/**
+ * Listener for websocket events.
+ * */
+export type WebsocketEventListener<K extends WebsocketEvent> = (instance: Websocket, ev: WebsocketEventMap[K]) => unknown;
+export type WebsocketEventListenerParams<K extends WebsocketEvent> = Parameters<WebsocketEventListener<K>>;
+/**
+ * Options for websocket event listeners. Only 'once' and 'signal' are
+ * supported: a websocket has no capture/bubble phases and its events are not
+ * cancelable, so the remaining AddEventListenerOptions have no meaning here.
+ */
+export type WebsocketEventListenerOptions = Pick<AddEventListenerOptions, "once" | "signal">;
+/**
+ * Listener for websocket events with options.
+ */
+export type WebsocketEventListenerWithOptions<K extends WebsocketEvent> = {
+    readonly listener: WebsocketEventListener<K>;
+    readonly options?: WebsocketEventListenerOptions;
+};
+/**
+ * Maps websocket events to their corresponding event-listeners.
+ */
+export type WebsocketEventListeners = {
+    [K in WebsocketEvent]: WebsocketEventListenerWithOptions<K>[];
+};
+//# sourceMappingURL=websocket_event.d.ts.map

package/dist/cjs/websocket_event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_event.d.ts","sourceRoot":"","sources":["../../src/websocket_event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB,2CAA2C;;IAG3C,2CAA2C;;IAG3C;;;;OAIG;;IAGH,wCAAwC;;IAGxC,2EAA2E;;IAG3E,gFAAgF;;IAGhF,iFAAiF;;CAEzE,CAAC;AAEX,0FAA0F;AAC1F,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD,0FAA0F;AAE1F,yBAAiB,cAAc,CAAC;IAC9B,KAAY,IAAI,GAAG,OAAO,cAAc,CAAC,IAAI,CAAC;IAC9C,KAAY,KAAK,GAAG,OAAO,cAAc,CAAC,KAAK,CAAC;IAChD,KAAY,KAAK,GAAG,OAAO,cAAc,CAAC,KAAK,CAAC;IAChD,KAAY,OAAO,GAAG,OAAO,cAAc,CAAC,OAAO,CAAC;IACpD,KAAY,KAAK,GAAG,OAAO,cAAc,CAAC,KAAK,CAAC;IAChD,KAAY,SAAS,GAAG,OAAO,cAAc,CAAC,SAAS,CAAC;IACxD,KAAY,SAAS,GAAG,OAAO,cAAc,CAAC,SAAS,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,wDAAwD;IACxD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,4HAA4H;IAC5H,QAAQ,CAAC,cAAc,EAAE,IAAI,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IACnC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAC9B,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACtD,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAC9D,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;CAC/D,CAAC;AAEF;;KAEK;AACL,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,IAAI,CAC7D,QAAQ,EAAE,SAAS,EACnB,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC,KACrB,OAAO,CAAC;AAEb,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAAI,UAAU,CAC7E,sBAAsB,CAAC,CAAC,CAAC,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,uBAAuB,EACvB,MAAM,GAAG,QAAQ,CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,CAAC,CAAC,SAAS,cAAc,IAAI;IACxE,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAE,6BAA6B,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;KACnC,CAAC,IAAI,cAAc,GAAG,iCAAiC,CAAC,CAAC,CAAC,EAAE;CAC9D,CAAC"}

package/dist/cjs/websocket_event.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketEvent = void 0;
+/**
+ * Events that can be fired by the websocket.
+ */
+exports.WebsocketEvent = {
+    /** Fired when the connection is opened. */
+    open: "open",
+    /** Fired when the connection is closed. */
+    close: "close",
+    /**
+     * Fired when the connection has been closed because of an error, such as when some data couldn't be sent.
+     * Also fired when an automatic retry fails because the URL provider or the WebSocket constructor threw;
+     * that event is an ErrorEvent whose 'error' is the thrown value.
+     */
+    error: "error",
+    /** Fired when a message is received. */
+    message: "message",
+    /** Fired when the websocket tries to reconnect after a connection loss. */
+    retry: "retry",
+    /** Fired when the websocket successfully reconnects after a connection loss. */
+    reconnect: "reconnect",
+    /** Fired when the websocket gives up reconnecting after exceeding maxRetries. */
+    exhausted: "exhausted",
+};
+//# sourceMappingURL=websocket_event.js.map

package/dist/cjs/websocket_event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_event.js","sourceRoot":"","sources":["../../src/websocket_event.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,cAAc,GAAG;IAC5B,2CAA2C;IAC3C,IAAI,EAAE,MAAM;IAEZ,2CAA2C;IAC3C,KAAK,EAAE,OAAO;IAEd;;;;OAIG;IACH,KAAK,EAAE,OAAO;IAEd,wCAAwC;IACxC,OAAO,EAAE,SAAS;IAElB,2EAA2E;IAC3E,KAAK,EAAE,OAAO;IAEd,gFAAgF;IAChF,SAAS,EAAE,WAAW;IAEtB,iFAAiF;IACjF,SAAS,EAAE,WAAW;CACd,CAAC"}

package/dist/{esm/src → cjs}/websocket_options.d.ts

@@ -1,6 +1,6 @@
-import { WebsocketBuffer } from "./websocket_buffer";
-import { WebsocketConnectionRetryOptions } from "./websocket_retry_options";
-import { WebsocketEventListeners } from "./websocket_event";
+import { WebsocketBuffer } from "./websocket_buffer.js";
+import { WebsocketConnectionRetryOptions } from "./websocket_retry_options.js";
+import { WebsocketEventListeners } from "./websocket_event.js";
 /**
  * Options that can be passed to the Websocket constructor.
  */
@@ -14,8 +14,9 @@ export interface WebsocketOptions {
      */
     readonly retry?: WebsocketConnectionRetryOptions;
     /**
-     * The initial listeners to add to the websocket.
+     * The initial listeners to add to the websocket. Event-types without
+     * listeners can be omitted.
      */
-    readonly listeners?: WebsocketEventListeners;
+    readonly listeners?: Partial<WebsocketEventListeners>;
 }
 //# sourceMappingURL=websocket_options.d.ts.map

package/dist/cjs/websocket_options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_options.d.ts","sourceRoot":"","sources":["../../src/websocket_options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,+BAA+B,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACvD"}

package/dist/cjs/websocket_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_options.js","sourceRoot":"","sources":["../../src/websocket_options.ts"],"names":[],"mappings":""}

package/dist/{esm/src → cjs}/websocket_retry_options.d.ts

@@ -1,14 +1,15 @@
-import { Backoff } from "./backoff/backoff";
+import { Backoff } from "./backoff/backoff.js";
 /**
  * Options for the websockets retry-strategy.
  */
 export interface WebsocketConnectionRetryOptions {
     /**
-     * The maximum number of retries before giving up. No limit if undefined.
+     * The maximum number of retries before giving up. No limit if undefined or Infinity.
+     * Must be Infinity or a non-negative integer; zero means no retry is ever made.
      */
     readonly maxRetries?: number;
     /**
-     * Wether to reconnect immediately after a connection has been lost,
+     * Whether to reconnect immediately after a connection has been lost,
      * ignoring the backoff strategy for the first retry.
      */
     readonly instantReconnect?: boolean;

package/dist/cjs/websocket_retry_options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_retry_options.d.ts","sourceRoot":"","sources":["../../src/websocket_retry_options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/dist/cjs/websocket_retry_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_retry_options.js","sourceRoot":"","sources":["../../src/websocket_retry_options.ts"],"names":[],"mappings":""}

package/dist/esm/{src/backoff → backoff}/backoff.d.ts

@@ -1,6 +1,9 @@
 /**
  * A Backoff produces a series of numbers that are used to determine
  * the delay between connection-retries. Values are expected to be in milliseconds.
+ *
+ * Implementations must not call back into the websocket (e.g. close() or reconnect()):
+ * the websocket calls them in the middle of its lifecycle transitions.
  */
 export interface Backoff {
     /**
@@ -8,12 +11,12 @@ export interface Backoff {
      */
     readonly retries: number;
     /**
-     * Current number in the series.
+     * Current number in the series, i.e. the value that the next call to next() will return.
      */
     readonly current: number;
     /**
-     * Advances the series to the next number and returns it.
-     * @return the next number in the series
+     * Returns the current number in the series and advances the series by one step.
+     * @return the current number in the series
      */
     next(): number;
     /**

package/dist/{cjs/src → esm}/backoff/backoff.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"backoff.d.ts","sourceRoot":"","sources":["../../../../src/backoff/backoff.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,IAAI,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}
+{"version":3,"file":"backoff.d.ts","sourceRoot":"","sources":["../../../src/backoff/backoff.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,IAAI,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}

package/dist/{cjs/src → esm}/backoff/backoff.js.map

@@ -1 +1 @@
-{"version":3,"file":"backoff.js","sourceRoot":"","sources":["../../../../src/backoff/backoff.ts"],"names":[],"mappings":""}
+{"version":3,"file":"backoff.js","sourceRoot":"","sources":["../../../src/backoff/backoff.ts"],"names":[],"mappings":""}

package/dist/esm/{src/backoff → backoff}/constantbackoff.d.ts

@@ -1,4 +1,4 @@
-import { Backoff } from "./backoff";
+import { Backoff } from "./backoff.js";
 /**
  * ConstantBackoff always returns the same backoff-time.
  */
@@ -7,7 +7,7 @@ export declare class ConstantBackoff implements Backoff {
     private _retries;
     /**
      * Creates a new ConstantBackoff.
-     * @param backoff the backoff-time to return
+     * @param backoff the backoff-time (in milliseconds) to return
      */
     constructor(backoff: number);
     get retries(): number;

package/dist/esm/backoff/constantbackoff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constantbackoff.d.ts","sourceRoot":"","sources":["../../../src/backoff/constantbackoff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC;;GAEG;AACH,qBAAa,eAAgB,YAAW,OAAO;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAa;IAE7B;;;OAGG;gBACS,OAAO,EAAE,MAAM;IAQ3B,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,IAAI,MAAM;IAKd,KAAK,IAAI,IAAI;CAGd"}

package/dist/esm/{src/backoff → backoff}/constantbackoff.js

@@ -4,12 +4,12 @@
 export class ConstantBackoff {
     /**
      * Creates a new ConstantBackoff.
-     * @param backoff the backoff-time to return
+     * @param backoff the backoff-time (in milliseconds) to return
      */
     constructor(backoff) {
         this._retries = 0;
-        if (!Number.isInteger(backoff) || backoff < 0) {
-            throw new Error("Backoff must be a positive integer");
+        if (!Number.isFinite(backoff) || backoff < 0) {
+            throw new Error("Backoff must be a finite, non-negative number");
         }
         this.backoff = backoff;
     }

package/dist/esm/backoff/constantbackoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constantbackoff.js","sourceRoot":"","sources":["../../../src/backoff/constantbackoff.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,eAAe;IAI1B;;;OAGG;IACH,YAAY,OAAe;QANnB,aAAQ,GAAW,CAAC,CAAC;QAO3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IACpB,CAAC;CACF"}

package/dist/{cjs/src → esm}/backoff/exponentialbackoff.d.ts

@@ -1,4 +1,4 @@
-import { Backoff } from "./backoff";
+import { Backoff } from "./backoff.js";
 /**
  * ExponentialBackoff increases the backoff-time exponentially.
  * An optional maximum can be provided as an upper bound to the
@@ -36,7 +36,7 @@ export declare class ExponentialBackoff implements Backoff {
     private _retries;
     /**
      * Creates a new ExponentialBackoff.
-     * @param base the base of the exponentiation
+     * @param base the base of the exponentiation (in milliseconds)
      * @param expMax the maximum exponent, no bound if undefined
      */
     constructor(base: number, expMax?: number);

package/dist/esm/backoff/exponentialbackoff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exponentialbackoff.d.ts","sourceRoot":"","sources":["../../../src/backoff/exponentialbackoff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,kBAAmB,YAAW,OAAO;IAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,CAAC,CAAS;IAClB,OAAO,CAAC,QAAQ,CAAa;IAE7B;;;;OAIG;gBACS,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAazC,IAAI,OAAO,WAEV;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,IAAI,MAAM;IAUd,KAAK,IAAI,IAAI;CAId"}

package/dist/esm/{src/backoff → backoff}/exponentialbackoff.js

@@ -31,16 +31,16 @@
 export class ExponentialBackoff {
     /**
      * Creates a new ExponentialBackoff.
-     * @param base the base of the exponentiation
+     * @param base the base of the exponentiation (in milliseconds)
      * @param expMax the maximum exponent, no bound if undefined
      */
     constructor(base, expMax) {
         this._retries = 0;
-        if (!Number.isInteger(base) || base < 0) {
-            throw new Error("Base must be a positive integer or zero");
+        if (!Number.isFinite(base) || base < 0) {
+            throw new Error("Base must be a finite, non-negative number");
         }
         if (expMax !== undefined && (!Number.isInteger(expMax) || expMax < 0)) {
-            throw new Error("ExpMax must be a undefined, a positive integer or zero");
+            throw new Error("ExpMax must be undefined or a non-negative integer");
         }
         this.base = base;
         this.expMax = expMax;
@@ -53,12 +53,13 @@ export class ExponentialBackoff {
         return this.base * Math.pow(2, this.i);
     }
     next() {
+        const backoff = this.current;
         this._retries++;
         this.i =
             this.expMax === undefined
                 ? this.i + 1
                 : Math.min(this.i + 1, this.expMax);
-        return this.current;
+        return backoff;
     }
     reset() {
         this._retries = 0;