Skip to content

Commit

Permalink
chore(typedoc): update and re-gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
enisdenjo committed Aug 31, 2020
1 parent 9a98ec4 commit cf71465
Show file tree
Hide file tree
Showing 22 changed files with 75 additions and 75 deletions.
12 changes: 6 additions & 6 deletions docs/enums/_message_.messagetype.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,44 @@ 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/bce17d7/src/message.ts#L24)*
*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L24)*

___

### ConnectionAck

**ConnectionAck**: = "connection_ack"

*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L19)*
*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L19)*

___

### ConnectionInit

**ConnectionInit**: = "connection_init"

*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L18)*
*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L18)*

___

### Error

**Error**: = "error"

*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L23)*
*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L23)*

___

### Next

**Next**: = "next"

*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L22)*
*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L22)*

___

### Subscribe

**Subscribe**: = "subscribe"

*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L21)*
*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L21)*
4 changes: 2 additions & 2 deletions docs/interfaces/_client_.client.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,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/bce17d7/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L17)*

Dispose of the instance and clear up resources.

Expand All @@ -40,7 +40,7 @@ Dispose of the instance and clear up resources.

**subscribe****T**›(`payload`: [SubscribePayload](_message_.subscribepayload.md), `sink`: [Sink](_types_.sink.md)‹T›): *function*

*Defined in [client.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/client.ts#L33)*
*Defined in [client.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/client.ts#L33)*

Subscribes through the WebSocket following the config parameters. It
uses the `sink` to emit received data or errors. Returns a _cleanup_
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_client_.clientoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Configuration used for the `create` client function.

**connectionParams**? : *Record‹string, unknown› | function*

*Defined in [client.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/client.ts#L24)*
*Defined in [client.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/client.ts#L24)*

Optional parameters that the client specifies when establishing a connection with the server.

Expand All @@ -31,6 +31,6 @@ ___

**url**: *string*

*Defined in [client.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/client.ts#L22)*
*Defined in [client.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/client.ts#L22)*

URL of the GraphQL server to connect.
4 changes: 2 additions & 2 deletions docs/interfaces/_message_.completemessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@

**id**: *string*

*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L61)*
*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L61)*

___

### `Readonly` type

**type**: *[Complete](../enums/_message_.messagetype.md#complete)*

*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L62)*
*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L62)*
2 changes: 1 addition & 1 deletion docs/interfaces/_message_.connectionackmessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

**type**: *[ConnectionAck](../enums/_message_.messagetype.md#connectionack)*

*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L33)*
*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L33)*
4 changes: 2 additions & 2 deletions docs/interfaces/_message_.connectioninitmessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@

**payload**? : *Record‹string, unknown›*

*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L29)*
*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L29)*

___

### `Readonly` type

**type**: *[ConnectionInit](../enums/_message_.messagetype.md#connectioninit)*

*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L28)*
*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L28)*
8 changes: 4 additions & 4 deletions docs/interfaces/_message_.errormessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@

**id**: *string*

*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L55)*
*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L55)*

___

### `Readonly` payload

**payload**: *keyof GraphQLError[]*
**payload**: *readonly GraphQLError[]*

*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L57)*
*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L57)*

___

### `Readonly` type

**type**: *[Error](../enums/_message_.messagetype.md#error)*

*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L56)*
*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L56)*
6 changes: 3 additions & 3 deletions docs/interfaces/_message_.nextmessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@

**id**: *string*

*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L49)*
*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L49)*

___

### `Readonly` payload

**payload**: *ExecutionResult*

*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L51)*
*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L51)*

___

### `Readonly` type

**type**: *[Next](../enums/_message_.messagetype.md#next)*

*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L50)*
*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L50)*
6 changes: 3 additions & 3 deletions docs/interfaces/_message_.subscribemessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@

**id**: *string*

*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L37)*
*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L37)*

___

### `Readonly` payload

**payload**: *[SubscribePayload](_message_.subscribepayload.md)*

*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L39)*
*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L39)*

___

### `Readonly` type

**type**: *[Subscribe](../enums/_message_.messagetype.md#subscribe)*

*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L38)*
*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L38)*
6 changes: 3 additions & 3 deletions docs/interfaces/_message_.subscribepayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@

**operationName**: *string*

*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L43)*
*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L43)*

___

### `Readonly` query

**query**: *string | DocumentNode*

*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L44)*
*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L44)*

___

### `Readonly` variables

**variables**: *Record‹string, unknown›*

*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/message.ts#L45)*
*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L45)*
12 changes: 6 additions & 6 deletions docs/interfaces/_server_.context.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

**acknowledged**: *boolean*

*Defined in [server.ts:163](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L163)*
*Defined in [server.ts:163](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L163)*

Indicates that the connection was acknowledged
by having dispatched the `ConnectionAck` message
Expand All @@ -35,7 +35,7 @@ ___

**connectionInitReceived**: *boolean*

*Defined in [server.ts:157](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L157)*
*Defined in [server.ts:157](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L157)*

Indicates that the `ConnectionInit` message
has been received by the server. If this is
Expand All @@ -48,7 +48,7 @@ ___

**connectionParams**? : *Readonly‹Record‹string, unknown››*

*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L165)*
*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L165)*

The parameters passed during the connection initialisation.

Expand All @@ -58,7 +58,7 @@ ___

**request**: *IncomingMessage*

*Defined in [server.ts:150](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L150)*
*Defined in [server.ts:150](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L150)*

The initial HTTP request before the actual
socket and connection is established.
Expand All @@ -69,7 +69,7 @@ ___

**socket**: *WebSocket*

*Defined in [server.ts:145](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L145)*
*Defined in [server.ts:145](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L145)*

The actual WebSocket connection between the server and the client.

Expand All @@ -79,7 +79,7 @@ ___

**subscriptions**: *Record‹[UUID](../modules/_types_.md#uuid), AsyncIterator‹unknown››*

*Defined in [server.ts:171](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L171)*
*Defined in [server.ts:171](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L171)*

Holds the active subscriptions for this context.
Subscriptions are for `subscription` operations **only**,
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_server_.server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/bce17d7/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L17)*

Dispose of the instance and clear up resources.

Expand All @@ -37,4 +37,4 @@ ___

**webSocketServer**: *Server*

*Defined in [server.ts:175](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L175)*
*Defined in [server.ts:175](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L175)*
20 changes: 10 additions & 10 deletions docs/interfaces/_server_.serveroptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

**connectionInitWaitTimeout**? : *undefined | number*

*Defined in [server.ts:104](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L104)*
*Defined in [server.ts:104](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L104)*

**`default`** 3 * 1000 (3 seconds)

Expand All @@ -46,7 +46,7 @@ ___

**execute**: *function*

*Defined in [server.ts:60](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L60)*
*Defined in [server.ts:60](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L60)*

Is the `subscribe` function
from GraphQL which is used to
Expand All @@ -69,7 +69,7 @@ ___

**formatExecutionResult**? : *[ExecutionResultFormatter](../modules/_server_.md#executionresultformatter)*

*Defined in [server.ts:116](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L116)*
*Defined in [server.ts:116](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L116)*

Format the operation execution results
if the implementation requires an adjusted
Expand All @@ -82,7 +82,7 @@ ___

**onComplete**? : *undefined | function*

*Defined in [server.ts:138](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L138)*
*Defined in [server.ts:138](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L138)*

The complete callback is executed after the
operation has completed or the subscription
Expand All @@ -94,7 +94,7 @@ ___

**onConnect**? : *undefined | function*

*Defined in [server.ts:90](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L90)*
*Defined in [server.ts:90](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L90)*

Is the connection callback called when the
client requests the connection initialisation
Expand All @@ -121,7 +121,7 @@ ___

**onSubscribe**? : *undefined | function*

*Defined in [server.ts:126](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L126)*
*Defined in [server.ts:126](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L126)*

The subscribe callback executed before
the actual operation execution. Useful
Expand All @@ -137,7 +137,7 @@ ___

**schema**? : *GraphQLSchema*

*Defined in [server.ts:53](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L53)*
*Defined in [server.ts:53](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L53)*

The GraphQL schema on which the operations
will be executed and validated against. If
Expand All @@ -151,7 +151,7 @@ ___

**subscribe**: *function*

*Defined in [server.ts:67](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L67)*
*Defined in [server.ts:67](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L67)*

Is the `subscribe` function
from GraphQL which is used to
Expand All @@ -172,9 +172,9 @@ ___

### `Optional` validationRules

**validationRules**? : *keyof ValidationRule[]*
**validationRules**? : *readonly ValidationRule[]*

*Defined in [server.ts:109](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L109)*
*Defined in [server.ts:109](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L109)*

Custom validation rules overriding all
validation rules defined by the GraphQL spec.
2 changes: 1 addition & 1 deletion docs/interfaces/_types_.disposable.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

**dispose**: *function*

*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L17)*

Dispose of the instance and clear up resources.

Expand Down
Loading

0 comments on commit cf71465

Please sign in to comment.