chore(deps): update and generate docs

enisdenjo · Feb 18, 2021 · d7767b2 · d7767b2
1 parent ea306db
commit d7767b2
Show file tree

Hide file tree

Showing 29 changed files with 297 additions and 306 deletions.
diff --git a/docs/interfaces/client.client-1.md b/docs/interfaces/client.client-1.md
@@ -25,30 +25,36 @@
 
 ### dispose
 
-• **dispose**: () => *void* \| *Promise*<*void*\>
+• **dispose**: () => *void* \| *Promise*<void\>
 
 Dispose of the instance and clear up resources.
 
+#### Type declaration:
+
+▸ (): *void* \| *Promise*<void\>
+
+**Returns:** *void* \| *Promise*<void\>
+
 Inherited from: [Disposable](types.disposable.md).[dispose](types.disposable.md#dispose)
 
 ## Methods
 
 ### on
 
-▸ **on**<E\>(`event`: E, `listener`: [*EventListener*](../modules/client.md#eventlistener)<E\>): *function*
+▸ **on**<E\>(`event`: E, `listener`: [*EventListener*](../modules/client.md#eventlistener)<E\>): () => *void*
 
 Listens on the client which dispatches events about the socket state.
 
 #### Type parameters:
 
 Name | Type |
------- | ------ |
+:------ | :------ |
 `E` | [*Event*](../modules/client.md#event) |
 
 #### Parameters:
 
 Name | Type |
------- | ------ |
+:------ | :------ |
 `event` | E |
 `listener` | [*EventListener*](../modules/client.md#eventlistener)<E\> |
 
@@ -58,7 +64,7 @@ ___
 
 ### subscribe
 
-▸ **subscribe**<T\>(`payload`: [*SubscribePayload*](message.subscribepayload.md), `sink`: [*Sink*](types.sink.md)<T\>): *function*
+▸ **subscribe**<T\>(`payload`: [*SubscribePayload*](message.subscribepayload.md), `sink`: [*Sink*](types.sink.md)<T\>): () => *void*
 
 Subscribes through the WebSocket following the config parameters. It
 uses the `sink` to emit received data or errors. Returns a _cleanup_
@@ -67,13 +73,13 @@ function used for dropping the subscription and cleaning stuff up.
 #### Type parameters:
 
 Name | Default |
------- | ------ |
+:------ | :------ |
 `T` | *unknown* |
 
 #### Parameters:
 
 Name | Type |
------- | ------ |
+:------ | :------ |
 `payload` | [*SubscribePayload*](message.subscribepayload.md) |
 `sink` | [*Sink*](types.sink.md)<T\> |
 

diff --git a/docs/interfaces/client.clientoptions.md b/docs/interfaces/client.clientoptions.md
@@ -6,10 +6,6 @@
 
 Configuration used for the GraphQL over WebSocket client.
 
-## Hierarchy
-
-* **ClientOptions**
-
 ## Table of contents
 
 ### Properties
@@ -29,7 +25,7 @@ Configuration used for the GraphQL over WebSocket client.
 
 ### connectionParams
 
-• `Optional` **connectionParams**: *undefined* \| *Record*<*string*, *unknown*\> \| () => *Record*<*string*, *unknown*\> \| *Promise*<*Record*<*string*, *unknown*\>\>
+• `Optional` **connectionParams**: *undefined* \| *Record*<string, unknown\> \| () => *Record*<string, unknown\> \| *Promise*<Record<string, unknown\>\>
 
 Optional parameters, passed through the `payload` field with the `ConnectionInit` message,
 that the client specifies when establishing a connection with the server. You can use this
@@ -82,7 +78,7 @@ ___
 
 ### on
 
-• `Optional` **on**: *undefined* \| *Partial*<{ `closed`: (`event`: *unknown*) => *void* ; `connected`: (`socket`: *unknown*, `payload?`: *Record*<*string*, *unknown*\>) => *void* ; `connecting`: () => *void*  }\>
+• `Optional` **on**: *undefined* \| *Partial*<{ `closed`: (`event`: *unknown*) => *void* ; `connected`: (`socket`: *unknown*, `payload?`: *Record*<string, unknown\>) => *void* ; `connecting`: () => *void*  }\>
 
 Register listeners before initialising the client. This way
 you can ensure to catch all client relevant emitted events.
@@ -138,7 +134,7 @@ ___
 
 ### retryWait
 
-• `Optional` **retryWait**: *undefined* \| (`retries`: *number*) => *Promise*<*void*\>
+• `Optional` **retryWait**: *undefined* \| (`retries`: *number*) => *Promise*<void\>
 
 Control the wait time between retries. You may implement your own strategy
 by timing the resolution of the returned promise with the retries count.

diff --git a/docs/interfaces/client.completemessage.md b/docs/interfaces/client.completemessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).CompleteMessage
 
-## Hierarchy
-
-* **CompleteMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/client.connectionackmessage.md b/docs/interfaces/client.connectionackmessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).ConnectionAckMessage
 
-## Hierarchy
-
-* **ConnectionAckMessage**
-
 ## Table of contents
 
 ### Properties
@@ -19,7 +15,7 @@
 
 ### payload
 
-• `Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **payload**: *undefined* \| *Record*<string, unknown\>
 
 ___
 

diff --git a/docs/interfaces/client.connectioninitmessage.md b/docs/interfaces/client.connectioninitmessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).ConnectionInitMessage
 
-## Hierarchy
-
-* **ConnectionInitMessage**
-
 ## Table of contents
 
 ### Properties
@@ -19,7 +15,7 @@
 
 ### payload
 
-• `Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **payload**: *undefined* \| *Record*<string, unknown\>
 
 ___
 

diff --git a/docs/interfaces/client.errormessage.md b/docs/interfaces/client.errormessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).ErrorMessage
 
-## Hierarchy
-
-* **ErrorMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/client.nextmessage.md b/docs/interfaces/client.nextmessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).NextMessage
 
-## Hierarchy
-
-* **NextMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/client.subscribemessage.md b/docs/interfaces/client.subscribemessage.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).SubscribeMessage
 
-## Hierarchy
-
-* **SubscribeMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/client.subscribepayload.md b/docs/interfaces/client.subscribepayload.md
@@ -4,10 +4,6 @@
 
 [client](../modules/client.md).SubscribePayload
 
-## Hierarchy
-
-* **SubscribePayload**
-
 ## Table of contents
 
 ### Properties
@@ -32,4 +28,4 @@ ___
 
 ### variables
 
-• `Optional` `Readonly` **variables**: *undefined* \| *null* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **variables**: *undefined* \| *null* \| *Record*<string, unknown\>
diff --git a/docs/interfaces/message.completemessage.md b/docs/interfaces/message.completemessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).CompleteMessage
 
-## Hierarchy
-
-* **CompleteMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/message.connectionackmessage.md b/docs/interfaces/message.connectionackmessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).ConnectionAckMessage
 
-## Hierarchy
-
-* **ConnectionAckMessage**
-
 ## Table of contents
 
 ### Properties
@@ -19,7 +15,7 @@
 
 ### payload
 
-• `Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **payload**: *undefined* \| *Record*<string, unknown\>
 
 ___
 

diff --git a/docs/interfaces/message.connectioninitmessage.md b/docs/interfaces/message.connectioninitmessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).ConnectionInitMessage
 
-## Hierarchy
-
-* **ConnectionInitMessage**
-
 ## Table of contents
 
 ### Properties
@@ -19,7 +15,7 @@
 
 ### payload
 
-• `Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **payload**: *undefined* \| *Record*<string, unknown\>
 
 ___
 

diff --git a/docs/interfaces/message.errormessage.md b/docs/interfaces/message.errormessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).ErrorMessage
 
-## Hierarchy
-
-* **ErrorMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/message.nextmessage.md b/docs/interfaces/message.nextmessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).NextMessage
 
-## Hierarchy
-
-* **NextMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/message.subscribemessage.md b/docs/interfaces/message.subscribemessage.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).SubscribeMessage
 
-## Hierarchy
-
-* **SubscribeMessage**
-
 ## Table of contents
 
 ### Properties

diff --git a/docs/interfaces/message.subscribepayload.md b/docs/interfaces/message.subscribepayload.md
@@ -4,10 +4,6 @@
 
 [message](../modules/message.md).SubscribePayload
 
-## Hierarchy
-
-* **SubscribePayload**
-
 ## Table of contents
 
 ### Properties
@@ -32,4 +28,4 @@ ___
 
 ### variables
 
-• `Optional` `Readonly` **variables**: *undefined* \| *null* \| *Record*<*string*, *unknown*\>
+• `Optional` `Readonly` **variables**: *undefined* \| *null* \| *Record*<string, unknown\>
diff --git a/docs/interfaces/server.context.md b/docs/interfaces/server.context.md
@@ -7,13 +7,9 @@
 ## Type parameters
 
 Name | Default |
------- | ------ |
+:------ | :------ |
 `E` | *unknown* |
 
-## Hierarchy
-
-* **Context**
-
 ## Table of contents
 
 ### Properties
@@ -49,7 +45,7 @@ ___
 
 ### connectionParams
 
-• `Optional` `Readonly` **connectionParams**: *undefined* \| *Readonly*<*Record*<*string*, *unknown*\>\>
+• `Optional` `Readonly` **connectionParams**: *undefined* \| *Readonly*<Record<string, unknown\>\>
 
 The parameters passed during the connection initialisation.
 
@@ -66,7 +62,7 @@ ___
 
 ### subscriptions
 
-• `Readonly` **subscriptions**: *Record*<*string*, *null* \| *AsyncIterator*<*unknown*, *any*, *undefined*\>\>
+• `Readonly` **subscriptions**: *Record*<string, *null* \| AsyncIterator<unknown, any, undefined\>\>
 
 Holds the active subscriptions for this context. **All operations**
 that are taking place are aggregated here. The user is _subscribed_

diff --git a/docs/interfaces/server.server-1.md b/docs/interfaces/server.server-1.md
@@ -7,13 +7,9 @@
 ## Type parameters
 
 Name | Default |
------- | ------ |
+:------ | :------ |
 `E` | *undefined* |
 
-## Hierarchy
-
-* **Server**
-
 ## Table of contents
 
 ### Methods
@@ -24,7 +20,7 @@ Name | Default |
 
 ### opened
 
-▸ **opened**(`socket`: [*WebSocket*](server.websocket.md), `ctxExtra`: E): *function*
+▸ **opened**(`socket`: [*WebSocket*](server.websocket.md), `ctxExtra`: E): (`code`: *number*, `reason`: *string*) => *Promise*<void\>
 
 New socket has beeen established. The lib will validate
 the protocol and use the socket accordingly. Returned promise
@@ -42,7 +38,7 @@ promise will resolve once the internal cleanup is complete.
 #### Parameters:
 
 Name | Type |
------- | ------ |
+:------ | :------ |
 `socket` | [*WebSocket*](server.websocket.md) |
 `ctxExtra` | E |