websocket-ts 1.1.0 → 2.1.1

package/src/websocket_builder.ts

@@ -0,0 +1,274 @@
+import { Backoff } from "./backoff/backoff";
+import {
+  WebsocketEvent,
+  WebsocketEventListener,
+  WebsocketEventListenerOptions,
+} from "./websocket_event";
+import { Websocket } from "./websocket";
+import { WebsocketBuffer } from "./websocket_buffer";
+import { WebsocketOptions } from "./websocket_options";
+
+/**
+ * Builder for websockets.
+ */
+export class WebsocketBuilder {
+  private readonly _url: string;
+
+  private _protocols?: string | string[];
+  private _options?: WebsocketOptions;
+
+  /**
+   * Creates a new WebsocketBuilder.
+   *
+   * @param url the url to connect to
+   */
+  constructor(url: string) {
+    this._url = url;
+  }
+
+  /**
+   * Getter for the url.
+   *
+   * @returns the url
+   */
+  get url(): string {
+    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
+   */
+  public withProtocols(
+    protocols: string | string[] | undefined,
+  ): WebsocketBuilder {
+    this._protocols = protocols;
+    return this;
+  }
+
+  /**
+   * Getter for the protocols.
+   *
+   * @returns the protocols, undefined if no protocols have been set
+   */
+  get protocols(): string | string[] | undefined {
+    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
+   */
+  public withMaxRetries(maxRetries: number | undefined): WebsocketBuilder {
+    this._options = {
+      ...this._options,
+      retry: { ...this._options?.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(): number | undefined {
+    return this._options?.retry?.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
+   */
+  public withInstantReconnect(
+    instantReconnect: boolean | undefined,
+  ): WebsocketBuilder {
+    this._options = {
+      ...this._options,
+      retry: { ...this._options?.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(): boolean | undefined {
+    return this._options?.retry?.instantReconnect;
+  }
+
+  /**
+   * Adds a backoff to the websocket. Subsequent calls to this method will override the previously set backoff.
+   *
+   * @param backoff the backoff to add
+   */
+  public withBackoff(backoff: Backoff | undefined): WebsocketBuilder {
+    this._options = {
+      ...this._options,
+      retry: { ...this._options?.retry, backoff },
+    };
+    return this;
+  }
+
+  /**
+   * Getter for the backoff.
+   *
+   * @returns the backoff, undefined if no backoff has been set
+   */
+  get backoff(): Backoff | undefined {
+    return this._options?.retry?.backoff;
+  }
+
+  /**
+   * Adds a buffer to the websocket. Subsequent calls to this method will override the previously set buffer.
+   *
+   * @param buffer the buffer to add
+   */
+  public withBuffer(buffer: WebsocketBuffer | undefined): WebsocketBuilder {
+    this._options = { ...this._options, buffer };
+    return this;
+  }
+
+  /**
+   * Getter for the buffer.
+   *
+   * @returns the buffer, undefined if no buffer has been set
+   */
+  get buffer(): WebsocketBuffer | undefined {
+    return this._options?.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
+   */
+  public onOpen(
+    listener: WebsocketEventListener<WebsocketEvent.open>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    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
+   */
+  public onClose(
+    listener: WebsocketEventListener<WebsocketEvent.close>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    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
+   */
+  public onError(
+    listener: WebsocketEventListener<WebsocketEvent.error>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    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
+   */
+  public onMessage(
+    listener: WebsocketEventListener<WebsocketEvent.message>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    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
+   */
+  public onRetry(
+    listener: WebsocketEventListener<WebsocketEvent.retry>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    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
+   */
+  public onReconnect(
+    listener: WebsocketEventListener<WebsocketEvent.reconnect>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    this.addListener(WebsocketEvent.reconnect, listener, options);
+    return this;
+  }
+
+  /**
+   * Builds the websocket.
+   *
+   * @return a new websocket, with the set options
+   */
+  public build(): Websocket {
+    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
+   */
+  private addListener<K extends WebsocketEvent>(
+    event: WebsocketEvent,
+    listener: WebsocketEventListener<K>,
+    options?: WebsocketEventListenerOptions,
+  ): WebsocketBuilder {
+    this._options = {
+      ...this._options,
+      listeners: {
+        open: this._options?.listeners?.open ?? [],
+        close: this._options?.listeners?.close ?? [],
+        error: this._options?.listeners?.error ?? [],
+        message: this._options?.listeners?.message ?? [],
+        retry: this._options?.listeners?.retry ?? [],
+        reconnect: this._options?.listeners?.reconnect ?? [],
+        [event]: [
+          ...(this._options?.listeners?.[event] ?? []),
+          { listener, options },
+        ],
+      },
+    };
+    return this;
+  }
+}

package/src/websocket_event.ts

@@ -0,0 +1,88 @@
+import { Websocket } from "./websocket";
+
+/**
+ * Events that can be fired by the websocket.
+ */
+export 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>[];
+};

package/src/websocket_options.ts

@@ -0,0 +1,23 @@
+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;
+}

package/src/websocket_retry_options.ts

@@ -0,0 +1,22 @@
+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;
+}

package/{tsconfig.json → tsconfig.cjs.json}

@@ -1,71 +1,71 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "lib",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "lib"]
-}
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true,                   /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                        /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist/cjs",                   /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    // "skipLibCheck": true,                  /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["src", "tests"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsconfig.esm.json

@@ -0,0 +1,71 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "es6",                          /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true,                   /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                        /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist/esm",                   /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    // "skipLibCheck": true,                  /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["src", "tests"],
+  "exclude": ["node_modules", "dist"]
+}

package/jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-    transform: {
-        "^.+\\.tsx?$": "ts-jest",
-    },
-    testRegex: "(/tests/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-    moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
-    collectCoverage: true
-};

package/lib/backoff/backoff.d.ts

@@ -1,18 +0,0 @@
-/**
- * Backoff provides a series of numbers. This series follows
- * a concrete pattern, e.g. be constant, linearly increasing,
- * exponentially increasing etc.
- */
-export interface Backoff {
-    /**
-     * Provides the callee with the next number in the
-     * series.
-     * @return the next number
-     */
-    next(): number;
-    /**
-     *  Resets the series to its starting-value.
-     */
-    reset(): void;
-}
-//# sourceMappingURL=backoff.d.ts.map