From d1f461a19ae1ed002b20231a7d21f7fc429ef5cc Mon Sep 17 00:00:00 2001
From: enisdenjo <badurinadenis@gmail.com>
Date: Fri, 18 Sep 2020 20:32:40 +0200
Subject: [PATCH] docs: generate

---
 docs/enums/_message_.messagetype.md           | 12 +++---
 docs/interfaces/_client_.client.md            |  6 +--
 docs/interfaces/_client_.clientoptions.md     | 12 +++---
 docs/interfaces/_message_.completemessage.md  |  4 +-
 .../_message_.connectionackmessage.md         |  2 +-
 .../_message_.connectioninitmessage.md        |  4 +-
 docs/interfaces/_message_.errormessage.md     |  6 +--
 docs/interfaces/_message_.nextmessage.md      |  6 +--
 docs/interfaces/_message_.subscribemessage.md |  6 +--
 docs/interfaces/_message_.subscribepayload.md |  6 +--
 docs/interfaces/_server_.context.md           | 12 +++---
 docs/interfaces/_server_.server.md            |  4 +-
 docs/interfaces/_server_.serveroptions.md     | 37 +++++++++++++------
 docs/interfaces/_types_.disposable.md         |  2 +-
 docs/interfaces/_types_.sink.md               |  6 +--
 docs/modules/_client_.md                      | 12 +++---
 docs/modules/_message_.md                     |  2 +-
 docs/modules/_protocol_.md                    |  2 +-
 docs/modules/_server_.md                      |  4 +-
 docs/modules/_types_.md                       |  2 +-
 20 files changed, 81 insertions(+), 66 deletions(-)

diff --git a/docs/enums/_message_.messagetype.md b/docs/enums/_message_.messagetype.md
index ef9400f4..40b9eafb 100644
--- a/docs/enums/_message_.messagetype.md
+++ b/docs/enums/_message_.messagetype.md
@@ -21,7 +21,7 @@ Types of messages allowed to be sent by the client/server over the WS protocol.
 
 • **Complete**: = "complete"
 
-*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L24)*
+*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L24)*
 
 ___
 
@@ -29,7 +29,7 @@ ___
 
 • **ConnectionAck**: = "connection_ack"
 
-*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L19)*
+*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L19)*
 
 ___
 
@@ -37,7 +37,7 @@ ___
 
 • **ConnectionInit**: = "connection_init"
 
-*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L18)*
+*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L18)*
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 • **Error**: = "error"
 
-*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L23)*
+*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L23)*
 
 ___
 
@@ -53,7 +53,7 @@ ___
 
 • **Next**: = "next"
 
-*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L22)*
+*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L22)*
 
 ___
 
@@ -61,4 +61,4 @@ ___
 
 • **Subscribe**: = "subscribe"
 
-*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L21)*
+*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L21)*
diff --git a/docs/interfaces/_client_.client.md b/docs/interfaces/_client_.client.md
index 4042adc4..6d8c8165 100644
--- a/docs/interfaces/_client_.client.md
+++ b/docs/interfaces/_client_.client.md
@@ -27,7 +27,7 @@
 
 *Inherited from [Disposable](_types_.disposable.md).[dispose](_types_.disposable.md#dispose)*
 
-*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L17)*
+*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L17)*
 
 Dispose of the instance and clear up resources.
 
@@ -41,7 +41,7 @@ Dispose of the instance and clear up resources.
 
 ▸ **on**‹**E**›(`event`: E, `listener`: [EventListener](../modules/_client_.md#eventlistener)‹E›): *function*
 
-*Defined in [client.ts:70](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L70)*
+*Defined in [client.ts:70](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L70)*
 
 Listens on the client which dispatches events about the socket state.
 
@@ -66,7 +66,7 @@ ___
 
 ▸ **subscribe**‹**T**›(`payload`: [SubscribePayload](_message_.subscribepayload.md), `sink`: [Sink](_types_.sink.md)‹T›): *function*
 
-*Defined in [client.ts:76](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L76)*
+*Defined in [client.ts:76](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L76)*
 
 Subscribes through the WebSocket following the config parameters. It
 uses the `sink` to emit received data or errors. Returns a _cleanup_
diff --git a/docs/interfaces/_client_.clientoptions.md b/docs/interfaces/_client_.clientoptions.md
index 67813545..ddc68ec3 100644
--- a/docs/interfaces/_client_.clientoptions.md
+++ b/docs/interfaces/_client_.clientoptions.md
@@ -25,7 +25,7 @@ Configuration used for the `create` client function.
 
 • **connectionParams**? : *Record‹string, unknown› | function*
 
-*Defined in [client.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L40)*
+*Defined in [client.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L40)*
 
 Optional parameters that the client specifies when establishing a connection with the server.
 
@@ -35,7 +35,7 @@ ___
 
 • **lazy**? : *undefined | false | true*
 
-*Defined in [client.ts:46](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L46)*
+*Defined in [client.ts:46](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L46)*
 
 Should the connection be established immediately and persisted
 or after the first listener subscribed.
@@ -48,7 +48,7 @@ ___
 
 • **on**? : *Partial‹object›*
 
-*Defined in [client.ts:63](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L63)*
+*Defined in [client.ts:63](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L63)*
 
 Register listeners before initialising the client. This way
 you can ensure to catch all client relevant emitted events.
@@ -61,7 +61,7 @@ ___
 
 • **retryAttempts**? : *undefined | number*
 
-*Defined in [client.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L51)*
+*Defined in [client.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L51)*
 
 How many times should the client try to reconnect on abnormal socket closure before it errors out?
 
@@ -73,7 +73,7 @@ ___
 
 • **retryTimeout**? : *undefined | number*
 
-*Defined in [client.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L56)*
+*Defined in [client.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L56)*
 
 How long should the client wait until attempting to retry.
 
@@ -85,6 +85,6 @@ ___
 
 • **url**: *string*
 
-*Defined in [client.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L38)*
+*Defined in [client.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L38)*
 
 URL of the GraphQL server to connect.
diff --git a/docs/interfaces/_message_.completemessage.md b/docs/interfaces/_message_.completemessage.md
index ee796d0c..44921d95 100644
--- a/docs/interfaces/_message_.completemessage.md
+++ b/docs/interfaces/_message_.completemessage.md
@@ -19,7 +19,7 @@
 
 • **id**: *string*
 
-*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L61)*
+*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L61)*
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 • **type**: *[Complete](../enums/_message_.messagetype.md#complete)*
 
-*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L62)*
+*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L62)*
diff --git a/docs/interfaces/_message_.connectionackmessage.md b/docs/interfaces/_message_.connectionackmessage.md
index ae03d3d3..92a31bcd 100644
--- a/docs/interfaces/_message_.connectionackmessage.md
+++ b/docs/interfaces/_message_.connectionackmessage.md
@@ -18,4 +18,4 @@
 
 • **type**: *[ConnectionAck](../enums/_message_.messagetype.md#connectionack)*
 
-*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L33)*
+*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L33)*
diff --git a/docs/interfaces/_message_.connectioninitmessage.md b/docs/interfaces/_message_.connectioninitmessage.md
index 8a21a4ce..6bdf8078 100644
--- a/docs/interfaces/_message_.connectioninitmessage.md
+++ b/docs/interfaces/_message_.connectioninitmessage.md
@@ -19,7 +19,7 @@
 
 • **payload**? : *Record‹string, unknown›*
 
-*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L29)*
+*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L29)*
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 • **type**: *[ConnectionInit](../enums/_message_.messagetype.md#connectioninit)*
 
-*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L28)*
+*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L28)*
diff --git a/docs/interfaces/_message_.errormessage.md b/docs/interfaces/_message_.errormessage.md
index 33778600..79c50436 100644
--- a/docs/interfaces/_message_.errormessage.md
+++ b/docs/interfaces/_message_.errormessage.md
@@ -20,7 +20,7 @@
 
 • **id**: *string*
 
-*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L55)*
+*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L55)*
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 • **payload**: *readonly GraphQLError[]*
 
-*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L57)*
+*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L57)*
 
 ___
 
@@ -36,4 +36,4 @@ ___
 
 • **type**: *[Error](../enums/_message_.messagetype.md#error)*
 
-*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L56)*
+*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L56)*
diff --git a/docs/interfaces/_message_.nextmessage.md b/docs/interfaces/_message_.nextmessage.md
index 49265b1e..dcc9b6e5 100644
--- a/docs/interfaces/_message_.nextmessage.md
+++ b/docs/interfaces/_message_.nextmessage.md
@@ -20,7 +20,7 @@
 
 • **id**: *string*
 
-*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L49)*
+*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L49)*
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 • **payload**: *ExecutionResult*
 
-*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L51)*
+*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L51)*
 
 ___
 
@@ -36,4 +36,4 @@ ___
 
 • **type**: *[Next](../enums/_message_.messagetype.md#next)*
 
-*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L50)*
+*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L50)*
diff --git a/docs/interfaces/_message_.subscribemessage.md b/docs/interfaces/_message_.subscribemessage.md
index 6ddd22c7..9a06b271 100644
--- a/docs/interfaces/_message_.subscribemessage.md
+++ b/docs/interfaces/_message_.subscribemessage.md
@@ -20,7 +20,7 @@
 
 • **id**: *string*
 
-*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L37)*
+*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L37)*
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 • **payload**: *[SubscribePayload](_message_.subscribepayload.md)*
 
-*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L39)*
+*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L39)*
 
 ___
 
@@ -36,4 +36,4 @@ ___
 
 • **type**: *[Subscribe](../enums/_message_.messagetype.md#subscribe)*
 
-*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L38)*
+*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L38)*
diff --git a/docs/interfaces/_message_.subscribepayload.md b/docs/interfaces/_message_.subscribepayload.md
index ae3f0ddd..bcf19a98 100644
--- a/docs/interfaces/_message_.subscribepayload.md
+++ b/docs/interfaces/_message_.subscribepayload.md
@@ -20,7 +20,7 @@
 
 • **operationName**? : *string | null*
 
-*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L43)*
+*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L43)*
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 • **query**: *string | DocumentNode*
 
-*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L44)*
+*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L44)*
 
 ___
 
@@ -36,4 +36,4 @@ ___
 
 • **variables**? : *Record‹string, unknown› | null*
 
-*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L45)*
+*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L45)*
diff --git a/docs/interfaces/_server_.context.md b/docs/interfaces/_server_.context.md
index 651fe4e2..f5756532 100644
--- a/docs/interfaces/_server_.context.md
+++ b/docs/interfaces/_server_.context.md
@@ -23,7 +23,7 @@
 
 • **acknowledged**: *boolean*
 
-*Defined in [server.ts:183](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L183)*
+*Defined in [server.ts:194](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L194)*
 
 Indicates that the connection was acknowledged
 by having dispatched the `ConnectionAck` message
@@ -35,7 +35,7 @@ ___
 
 • **connectionInitReceived**: *boolean*
 
-*Defined in [server.ts:177](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L177)*
+*Defined in [server.ts:188](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L188)*
 
 Indicates that the `ConnectionInit` message
 has been received by the server. If this is
@@ -48,7 +48,7 @@ ___
 
 • **connectionParams**? : *Readonly‹Record‹string, unknown››*
 
-*Defined in [server.ts:185](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L185)*
+*Defined in [server.ts:196](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L196)*
 
 The parameters passed during the connection initialisation.
 
@@ -58,7 +58,7 @@ ___
 
 • **request**: *IncomingMessage*
 
-*Defined in [server.ts:170](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L170)*
+*Defined in [server.ts:181](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L181)*
 
 The initial HTTP request before the actual
 socket and connection is established.
@@ -69,7 +69,7 @@ ___
 
 • **socket**: *WebSocket*
 
-*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L165)*
+*Defined in [server.ts:176](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L176)*
 
 The actual WebSocket connection between the server and the client.
 
@@ -79,7 +79,7 @@ ___
 
 • **subscriptions**: *Record‹[UUID](../modules/_types_.md#uuid), AsyncIterator‹unknown››*
 
-*Defined in [server.ts:191](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L191)*
+*Defined in [server.ts:202](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L202)*
 
 Holds the active subscriptions for this context.
 Subscriptions are for `subscription` operations **only**,
diff --git a/docs/interfaces/_server_.server.md b/docs/interfaces/_server_.server.md
index 736122b7..76ffa2fd 100644
--- a/docs/interfaces/_server_.server.md
+++ b/docs/interfaces/_server_.server.md
@@ -23,7 +23,7 @@
 
 *Inherited from [Disposable](_types_.disposable.md).[dispose](_types_.disposable.md#dispose)*
 
-*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L17)*
+*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L17)*
 
 Dispose of the instance and clear up resources.
 
@@ -37,4 +37,4 @@ ___
 
 • **webSocketServer**: *Server*
 
-*Defined in [server.ts:195](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L195)*
+*Defined in [server.ts:206](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L206)*
diff --git a/docs/interfaces/_server_.serveroptions.md b/docs/interfaces/_server_.serveroptions.md
index a2ace595..0d66c980 100644
--- a/docs/interfaces/_server_.serveroptions.md
+++ b/docs/interfaces/_server_.serveroptions.md
@@ -11,6 +11,7 @@
 ### Properties
 
 * [connectionInitWaitTimeout](_server_.serveroptions.md#optional-connectioninitwaittimeout)
+* [context](_server_.serveroptions.md#optional-context)
 * [execute](_server_.serveroptions.md#execute)
 * [formatExecutionResult](_server_.serveroptions.md#optional-formatexecutionresult)
 * [keepAlive](_server_.serveroptions.md#optional-keepalive)
@@ -28,7 +29,7 @@
 
 • **connectionInitWaitTimeout**? : *undefined | number*
 
-*Defined in [server.ts:115](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L115)*
+*Defined in [server.ts:126](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L126)*
 
 **`default`** 3 * 1000 (3 seconds)
 
@@ -44,11 +45,25 @@ dispatching a close event `4408: Connection initialisation timeout`
 
 ___
 
+### `Optional` context
+
+• **context**? : *SubscriptionArgs["contextValue"]*
+
+*Defined in [server.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L62)*
+
+A value which is provided to every resolver and holds
+important contextual information like the currently
+logged in user, or access to a database.
+Related operation context value will be injected to the
+`ExecutionArgs` BEFORE the `onSubscribe` callback.
+
+___
+
 ###  execute
 
 • **execute**: *function*
 
-*Defined in [server.ts:71](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L71)*
+*Defined in [server.ts:82](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L82)*
 
 Is the `subscribe` function
 from GraphQL which is used to
@@ -71,7 +86,7 @@ ___
 
 • **formatExecutionResult**? : *[ExecutionResultFormatter](../modules/_server_.md#executionresultformatter)*
 
-*Defined in [server.ts:127](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L127)*
+*Defined in [server.ts:138](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L138)*
 
 Format the operation execution results
 if the implementation requires an adjusted
@@ -84,7 +99,7 @@ ___
 
 • **keepAlive**? : *undefined | number*
 
-*Defined in [server.ts:158](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L158)*
+*Defined in [server.ts:169](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L169)*
 
 The timout between dispatched keep-alive messages. Internally the lib
 uses the [WebSocket Ping and Pongs]((https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#Pings_and_Pongs_The_Heartbeat_of_WebSockets)) to check that the link between
@@ -99,7 +114,7 @@ ___
 
 • **onComplete**? : *undefined | function*
 
-*Defined in [server.ts:149](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L149)*
+*Defined in [server.ts:160](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L160)*
 
 The complete callback is executed after the
 operation has completed or the subscription
@@ -111,7 +126,7 @@ ___
 
 • **onConnect**? : *undefined | function*
 
-*Defined in [server.ts:101](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L101)*
+*Defined in [server.ts:112](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L112)*
 
 Is the connection callback called when the
 client requests the connection initialisation
@@ -138,7 +153,7 @@ ___
 
 • **onSubscribe**? : *undefined | function*
 
-*Defined in [server.ts:137](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L137)*
+*Defined in [server.ts:148](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L148)*
 
 The subscribe callback executed before
 the actual operation execution. Useful
@@ -154,7 +169,7 @@ ___
 
 • **roots**? : *undefined | object*
 
-*Defined in [server.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L62)*
+*Defined in [server.ts:70](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L70)*
 
 The GraphQL root fields or resolvers to go
 alongside the schema. Learn more about them
@@ -168,7 +183,7 @@ ___
 
 • **schema**? : *GraphQLSchema*
 
-*Defined in [server.ts:54](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L54)*
+*Defined in [server.ts:54](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L54)*
 
 The GraphQL schema on which the operations
 will be executed and validated against. If
@@ -182,7 +197,7 @@ ___
 
 • **subscribe**: *function*
 
-*Defined in [server.ts:78](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L78)*
+*Defined in [server.ts:89](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L89)*
 
 Is the `subscribe` function
 from GraphQL which is used to
@@ -205,7 +220,7 @@ ___
 
 • **validationRules**? : *readonly ValidationRule[]*
 
-*Defined in [server.ts:120](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L120)*
+*Defined in [server.ts:131](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L131)*
 
 Custom validation rules overriding all
 validation rules defined by the GraphQL spec.
diff --git a/docs/interfaces/_types_.disposable.md b/docs/interfaces/_types_.disposable.md
index 791fa8cc..eef854aa 100644
--- a/docs/interfaces/_types_.disposable.md
+++ b/docs/interfaces/_types_.disposable.md
@@ -22,7 +22,7 @@
 
 • **dispose**: *function*
 
-*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L17)*
+*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L17)*
 
 Dispose of the instance and clear up resources.
 
diff --git a/docs/interfaces/_types_.sink.md b/docs/interfaces/_types_.sink.md
index aa14b818..6e0d65d0 100644
--- a/docs/interfaces/_types_.sink.md
+++ b/docs/interfaces/_types_.sink.md
@@ -26,7 +26,7 @@ A representation of any set of values over any amount of time.
 
 ▸ **complete**(): *void*
 
-*Defined in [types.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L29)*
+*Defined in [types.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L29)*
 
 The sink has completed. This function "closes" the sink.
 
@@ -38,7 +38,7 @@ ___
 
 ▸ **error**(`error`: Error | CloseEvent | readonly GraphQLError[]): *void*
 
-*Defined in [types.ts:27](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L27)*
+*Defined in [types.ts:27](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L27)*
 
 An error that has occured. Calling this function "closes" the sink.
 
@@ -56,7 +56,7 @@ ___
 
 ▸ **next**(`value`: T): *void*
 
-*Defined in [types.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L25)*
+*Defined in [types.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L25)*
 
 Next value arriving.
 
diff --git a/docs/modules/_client_.md b/docs/modules/_client_.md
index b82f6753..4b2c218e 100644
--- a/docs/modules/_client_.md
+++ b/docs/modules/_client_.md
@@ -27,7 +27,7 @@
 
 Ƭ **Event**: *[EventConnecting](_client_.md#eventconnecting) | [EventConnected](_client_.md#eventconnected) | [EventClosed](_client_.md#eventclosed)*
 
-*Defined in [client.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L23)*
+*Defined in [client.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L23)*
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 Ƭ **EventClosed**: *"closed"*
 
-*Defined in [client.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L22)*
+*Defined in [client.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L22)*
 
 ___
 
@@ -43,7 +43,7 @@ ___
 
 Ƭ **EventConnected**: *"connected"*
 
-*Defined in [client.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L21)*
+*Defined in [client.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L21)*
 
 ___
 
@@ -51,7 +51,7 @@ ___
 
 Ƭ **EventConnecting**: *"connecting"*
 
-*Defined in [client.ts:20](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L20)*
+*Defined in [client.ts:20](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L20)*
 
 ___
 
@@ -59,7 +59,7 @@ ___
 
 Ƭ **EventListener**: *E extends EventConnecting ? function : E extends EventConnected ? function : E extends EventClosed ? function : never*
 
-*Defined in [client.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L25)*
+*Defined in [client.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L25)*
 
 ## Functions
 
@@ -67,7 +67,7 @@ ___
 
 ▸ **createClient**(`options`: [ClientOptions](../interfaces/_client_.clientoptions.md)): *[Client](../interfaces/_client_.client.md)*
 
-*Defined in [client.ts:80](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L80)*
+*Defined in [client.ts:80](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/client.ts#L80)*
 
 Creates a disposable GraphQL subscriptions client.
 
diff --git a/docs/modules/_message_.md b/docs/modules/_message_.md
index 581c0656..26754566 100644
--- a/docs/modules/_message_.md
+++ b/docs/modules/_message_.md
@@ -28,4 +28,4 @@
 
 Ƭ **Message**: *T extends ConnectionAck ? ConnectionAckMessage : T extends ConnectionInit ? ConnectionInitMessage : T extends Subscribe ? SubscribeMessage : T extends Next ? NextMessage : T extends Error ? ErrorMessage : T extends Complete ? CompleteMessage : never*
 
-*Defined in [message.ts:65](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L65)*
+*Defined in [message.ts:65](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/message.ts#L65)*
diff --git a/docs/modules/_protocol_.md b/docs/modules/_protocol_.md
index bdef5caf..cf72d4bb 100644
--- a/docs/modules/_protocol_.md
+++ b/docs/modules/_protocol_.md
@@ -16,6 +16,6 @@ protocol
 
 • **GRAPHQL_TRANSPORT_WS_PROTOCOL**: *"graphql-transport-ws"* = "graphql-transport-ws"
 
-*Defined in [protocol.ts:8](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/protocol.ts#L8)*
+*Defined in [protocol.ts:8](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/protocol.ts#L8)*
 
 The WebSocket sub-protocol used for the [GraphQL over WebSocket Protocol](/PROTOCOL.md).
diff --git a/docs/modules/_server_.md b/docs/modules/_server_.md
index 4e8ea379..87880fb8 100644
--- a/docs/modules/_server_.md
+++ b/docs/modules/_server_.md
@@ -24,7 +24,7 @@
 
 Ƭ **ExecutionResultFormatter**: *function*
 
-*Defined in [server.ts:41](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L41)*
+*Defined in [server.ts:41](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L41)*
 
 #### Type declaration:
 
@@ -43,7 +43,7 @@ Name | Type |
 
 ▸ **createServer**(`options`: [ServerOptions](../interfaces/_server_.serveroptions.md), `websocketOptionsOrServer`: WebSocketServerOptions | WebSocketServer): *[Server](../interfaces/_server_.server.md)*
 
-*Defined in [server.ts:207](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L207)*
+*Defined in [server.ts:218](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/server.ts#L218)*
 
 Creates a protocol complient WebSocket GraphQL
 subscription server. Read more about the protocol
diff --git a/docs/modules/_types_.md b/docs/modules/_types_.md
index ed8e1882..16813212 100644
--- a/docs/modules/_types_.md
+++ b/docs/modules/_types_.md
@@ -19,7 +19,7 @@
 
 Ƭ **UUID**: *string*
 
-*Defined in [types.ts:13](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L13)*
+*Defined in [types.ts:13](https://github.com/enisdenjo/graphql-transport-ws/blob/5b3d253/src/types.ts#L13)*
 
 UUID v4 string type alias generated through the
 `generateUUID` function from the client.