websocket-ts 2.1.1 → 2.1.3

package/dist/esm/src/websocket_builder.d.ts

@@ -0,0 +1,147 @@
+import { Backoff } from "./backoff/backoff";
+import { WebsocketEvent, WebsocketEventListener, WebsocketEventListenerOptions } from "./websocket_event";
+import { Websocket } from "./websocket";
+import { WebsocketBuffer } from "./websocket_buffer";
+/**
+ * Builder for websockets.
+ */
+export declare class WebsocketBuilder {
+    private readonly _url;
+    private _protocols?;
+    private _options?;
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to
+     */
+    constructor(url: string);
+    /**
+     * Getter for the url.
+     *
+     * @returns the url
+     */
+    get url(): string;
+    /**
+     * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
+     *
+     * @param protocols the protocols to add
+     */
+    withProtocols(protocols: string | string[] | undefined): WebsocketBuilder;
+    /**
+     * Getter for the protocols.
+     *
+     * @returns the protocols, undefined if no protocols have been set
+     */
+    get protocols(): string | string[] | undefined;
+    /**
+     * Sets the maximum number of retries before giving up. No limit if undefined.
+     *
+     * @param maxRetries the maximum number of retries before giving up
+     */
+    withMaxRetries(maxRetries: number | undefined): WebsocketBuilder;
+    /**
+     * 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(): number | undefined;
+    /**
+     * Sets wether 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
+     */
+    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.
+     *
+     * @returns wether to reconnect immediately after a connection has been lost, undefined if no value has been set
+     */
+    get instantReconnect(): boolean | undefined;
+    /**
+     * 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: Backoff | undefined): WebsocketBuilder;
+    /**
+     * Getter for the backoff.
+     *
+     * @returns the backoff, undefined if no backoff has been set
+     */
+    get backoff(): Backoff | undefined;
+    /**
+     * 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: WebsocketBuffer | undefined): WebsocketBuilder;
+    /**
+     * Getter for the buffer.
+     *
+     * @returns the buffer, undefined if no buffer has been set
+     */
+    get buffer(): WebsocketBuffer | undefined;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.open>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.close>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.error>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.message>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.retry>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * 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: WebsocketEventListener<WebsocketEvent.reconnect>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    build(): Websocket;
+    /**
+     * 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
+     */
+    private addListener;
+}
+//# sourceMappingURL=websocket_builder.d.ts.map

package/dist/esm/src/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,mBAAmB,CAAC;AAC5C,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGrD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO,CAAC,UAAU,CAAC,CAAoB;IACvC,OAAO,CAAC,QAAQ,CAAC,CAAmB;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,MAAM;IAIvB;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;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;;;;OAIG;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;;;;OAIG;IACI,KAAK,IAAI,SAAS;IAIzB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAsBpB"}

package/dist/esm/src/websocket_builder.js

@@ -0,0 +1,213 @@
+import { WebsocketEvent, } from "./websocket_event";
+import { Websocket } from "./websocket";
+/**
+ * Builder for websockets.
+ */
+export class WebsocketBuilder {
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to
+     */
+    constructor(url) {
+        this._url = url;
+    }
+    /**
+     * Getter for the url.
+     *
+     * @returns the url
+     */
+    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.
+     *
+     * @param maxRetries the maximum number of retries before giving up
+     */
+    withMaxRetries(maxRetries) {
+        var _a;
+        this._options = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_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 wether 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
+     */
+    withInstantReconnect(instantReconnect) {
+        var _a;
+        this._options = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { instantReconnect }) });
+        return this;
+    }
+    /**
+     * Getter for wether 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
+     */
+    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 = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_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 = Object.assign(Object.assign({}, 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(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(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(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(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(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(WebsocketEvent.reconnect, listener, options);
+        return this;
+    }
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    build() {
+        return new 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, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        this._options = Object.assign(Object.assign({}, this._options), { listeners: {
+                open: (_c = (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.listeners) === null || _b === void 0 ? void 0 : _b.open) !== null && _c !== void 0 ? _c : [],
+                close: (_f = (_e = (_d = this._options) === null || _d === void 0 ? void 0 : _d.listeners) === null || _e === void 0 ? void 0 : _e.close) !== null && _f !== void 0 ? _f : [],
+                error: (_j = (_h = (_g = this._options) === null || _g === void 0 ? void 0 : _g.listeners) === null || _h === void 0 ? void 0 : _h.error) !== null && _j !== void 0 ? _j : [],
+                message: (_m = (_l = (_k = this._options) === null || _k === void 0 ? void 0 : _k.listeners) === null || _l === void 0 ? void 0 : _l.message) !== null && _m !== void 0 ? _m : [],
+                retry: (_q = (_p = (_o = this._options) === null || _o === void 0 ? void 0 : _o.listeners) === null || _p === void 0 ? void 0 : _p.retry) !== null && _q !== void 0 ? _q : [],
+                reconnect: (_t = (_s = (_r = this._options) === null || _r === void 0 ? void 0 : _r.listeners) === null || _s === void 0 ? void 0 : _s.reconnect) !== null && _t !== void 0 ? _t : [],
+                [event]: [
+                    ...((_w = (_v = (_u = this._options) === null || _u === void 0 ? void 0 : _u.listeners) === null || _v === void 0 ? void 0 : _v[event]) !== null && _w !== void 0 ? _w : []),
+                    { listener, options },
+                ],
+            } });
+        return this;
+    }
+}
+//# sourceMappingURL=websocket_builder.js.map

package/dist/esm/src/websocket_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.js","sourceRoot":"","sources":["../../../src/websocket_builder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,GAGf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAM3B;;;;OAIG;IACH,YAAY,GAAW;QACrB,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;;;;OAIG;IACI,cAAc,CAAC,UAA8B;;QAClD,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,UAAU,MAC7C,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,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,gBAAgB,MACnD,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,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,OAAO,MAC1C,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,mCAAQ,IAAI,CAAC,QAAQ,KAAE,MAAM,GAAE,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,cAAc,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,cAAc,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,cAAc,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,cAAc,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,cAAc,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,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iDAAiD;IACpH,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CACjB,KAAqB,EACrB,QAAmC,EACnC,OAAuC;;QAEvC,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,SAAS,EAAE;gBACT,IAAI,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,IAAI,mCAAI,EAAE;gBAC1C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,OAAO,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,OAAO,mCAAI,EAAE;gBAChD,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,SAAS,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,SAAS,mCAAI,EAAE;gBACpD,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,GACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/esm/src/websocket_event.d.ts

@@ -0,0 +1,67 @@
+import { Websocket } from "./websocket";
+/**
+ * Events that can be fired by the websocket.
+ */
+export declare enum 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. */
+    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"
+}
+/***
+ * 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 when the connection was lost or undefined if the connection has never been established. */
+    readonly lastConnection: Date | undefined;
+};
+/**
+ * Properties of a reconnect-event.
+ */
+export type ReconnectEventDetail = 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>;
+};
+/**
+ * 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 events.
+ */
+export type WebsocketEventListenerOptions = EventListenerOptions & AddEventListenerOptions;
+/**
+ * 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/esm/src/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,aAAa,CAAC;AAExC;;GAEG;AACH,oBAAY,cAAc;IACxB,2CAA2C;IAC3C,IAAI,SAAS;IAEb,2CAA2C;IAC3C,KAAK,UAAU;IAEf,8GAA8G;IAC9G,KAAK,UAAU;IAEf,wCAAwC;IACxC,OAAO,YAAY;IAEnB,2EAA2E;IAC3E,KAAK,UAAU;IAEf,gFAAgF;IAChF,SAAS,cAAc;CACxB;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,2GAA2G;IAC3G,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;;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;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;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,GAC9D,uBAAuB,CAAC;AAE1B;;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/esm/src/websocket_event.js

@@ -0,0 +1,19 @@
+/**
+ * Events that can be fired by the websocket.
+ */
+export var WebsocketEvent;
+(function (WebsocketEvent) {
+    /** Fired when the connection is opened. */
+    WebsocketEvent["open"] = "open";
+    /** Fired when the connection is closed. */
+    WebsocketEvent["close"] = "close";
+    /** Fired when the connection has been closed because of an error, such as when some data couldn't be sent. */
+    WebsocketEvent["error"] = "error";
+    /** Fired when a message is received. */
+    WebsocketEvent["message"] = "message";
+    /** Fired when the websocket tries to reconnect after a connection loss. */
+    WebsocketEvent["retry"] = "retry";
+    /** Fired when the websocket successfully reconnects after a connection loss. */
+    WebsocketEvent["reconnect"] = "reconnect";
+})(WebsocketEvent || (WebsocketEvent = {}));
+//# sourceMappingURL=websocket_event.js.map

package/dist/esm/src/websocket_event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_event.js","sourceRoot":"","sources":["../../../src/websocket_event.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,cAkBX;AAlBD,WAAY,cAAc;IACxB,2CAA2C;IAC3C,+BAAa,CAAA;IAEb,2CAA2C;IAC3C,iCAAe,CAAA;IAEf,8GAA8G;IAC9G,iCAAe,CAAA;IAEf,wCAAwC;IACxC,qCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,iCAAe,CAAA;IAEf,gFAAgF;IAChF,yCAAuB,CAAA;AACzB,CAAC,EAlBW,cAAc,KAAd,cAAc,QAkBzB"}

package/dist/esm/src/websocket_options.d.ts

@@ -0,0 +1,21 @@
+import { WebsocketBuffer } from "./websocket_buffer";
+import { WebsocketConnectionRetryOptions } from "./websocket_retry_options";
+import { WebsocketEventListeners } from "./websocket_event";
+/**
+ * Options that can be passed to the Websocket constructor.
+ */
+export interface WebsocketOptions {
+    /**
+     * The Buffer to use.
+     */
+    readonly buffer?: WebsocketBuffer;
+    /**
+     * The options for the connection-retry-strategy.
+     */
+    readonly retry?: WebsocketConnectionRetryOptions;
+    /**
+     * The initial listeners to add to the websocket.
+     */
+    readonly listeners?: WebsocketEventListeners;
+}
+//# sourceMappingURL=websocket_options.d.ts.map

package/dist/esm/src/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,oBAAoB,CAAC;AACrD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D;;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;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,uBAAuB,CAAC;CAC9C"}

package/dist/esm/src/websocket_options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=websocket_options.js.map

package/dist/esm/src/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/websocket_retry_options.d.ts

@@ -0,0 +1,20 @@
+import { Backoff } from "./backoff/backoff";
+/**
+ * Options for the websockets retry-strategy.
+ */
+export interface WebsocketConnectionRetryOptions {
+    /**
+     * The maximum number of retries before giving up. No limit if undefined.
+     */
+    readonly maxRetries?: number;
+    /**
+     * Wether to reconnect immediately after a connection has been lost,
+     * ignoring the backoff strategy for the first retry.
+     */
+    readonly instantReconnect?: boolean;
+    /**
+     * The backoff strategy to use. This is used to determine the delay between connection-retries.
+     */
+    readonly backoff?: Backoff;
+}
+//# sourceMappingURL=websocket_retry_options.d.ts.map

package/dist/esm/src/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,mBAAmB,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;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/esm/src/websocket_retry_options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=websocket_retry_options.js.map

package/dist/esm/src/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "websocket-ts",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "main": "dist/cjs/src/index.js",
   "types": "dist/cjs/src/index.d.ts",
   "module": "dist/esm/src/index.js",