From cf71465ebf2bafbc41082dc0bf2062cc1e2ed912 Mon Sep 17 00:00:00 2001 From: Denis Badurina Date: Mon, 31 Aug 2020 17:36:11 +0200 Subject: [PATCH] chore(typedoc): update and re-gen docs --- docs/enums/_message_.messagetype.md | 12 +++---- docs/interfaces/_client_.client.md | 4 +-- docs/interfaces/_client_.clientoptions.md | 4 +-- docs/interfaces/_message_.completemessage.md | 4 +-- .../_message_.connectionackmessage.md | 2 +- .../_message_.connectioninitmessage.md | 4 +-- docs/interfaces/_message_.errormessage.md | 8 ++--- 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 | 20 ++++++------ docs/interfaces/_types_.disposable.md | 2 +- docs/interfaces/_types_.sink.md | 10 +++--- docs/modules/_client_.md | 2 +- docs/modules/_message_.md | 2 +- docs/modules/_protocol_.md | 2 +- docs/modules/_server_.md | 4 +-- docs/modules/_types_.md | 2 +- package.json | 2 +- yarn.lock | 32 +++++++++---------- 22 files changed, 75 insertions(+), 75 deletions(-) diff --git a/docs/enums/_message_.messagetype.md b/docs/enums/_message_.messagetype.md index a2caaa5b..61e16d83 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/bce17d7/src/message.ts#L24)* +*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L24)* ___ @@ -29,7 +29,7 @@ ___ • **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)* ___ @@ -37,7 +37,7 @@ ___ • **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)* ___ @@ -45,7 +45,7 @@ ___ • **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)* ___ @@ -53,7 +53,7 @@ ___ • **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)* ___ @@ -61,4 +61,4 @@ ___ • **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)* diff --git a/docs/interfaces/_client_.client.md b/docs/interfaces/_client_.client.md index 108d9361..8dc2b03a 100644 --- a/docs/interfaces/_client_.client.md +++ b/docs/interfaces/_client_.client.md @@ -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. @@ -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_ diff --git a/docs/interfaces/_client_.clientoptions.md b/docs/interfaces/_client_.clientoptions.md index 64b11494..b36219d4 100644 --- a/docs/interfaces/_client_.clientoptions.md +++ b/docs/interfaces/_client_.clientoptions.md @@ -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. @@ -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. diff --git a/docs/interfaces/_message_.completemessage.md b/docs/interfaces/_message_.completemessage.md index e73b3e05..f2ab0f65 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/bce17d7/src/message.ts#L61)* +*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/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/bce17d7/src/message.ts#L62)* +*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L62)* diff --git a/docs/interfaces/_message_.connectionackmessage.md b/docs/interfaces/_message_.connectionackmessage.md index 730aec73..48543f8c 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/bce17d7/src/message.ts#L33)* +*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L33)* diff --git a/docs/interfaces/_message_.connectioninitmessage.md b/docs/interfaces/_message_.connectioninitmessage.md index 6cf3ca18..091fd534 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/bce17d7/src/message.ts#L29)* +*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/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/bce17d7/src/message.ts#L28)* +*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L28)* diff --git a/docs/interfaces/_message_.errormessage.md b/docs/interfaces/_message_.errormessage.md index 6c1146d8..12cb9788 100644 --- a/docs/interfaces/_message_.errormessage.md +++ b/docs/interfaces/_message_.errormessage.md @@ -20,15 +20,15 @@ • **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)* ___ @@ -36,4 +36,4 @@ ___ • **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)* diff --git a/docs/interfaces/_message_.nextmessage.md b/docs/interfaces/_message_.nextmessage.md index bb92a2dc..63cbfe6b 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/bce17d7/src/message.ts#L49)* +*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L49)* ___ @@ -28,7 +28,7 @@ ___ • **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)* ___ @@ -36,4 +36,4 @@ ___ • **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)* diff --git a/docs/interfaces/_message_.subscribemessage.md b/docs/interfaces/_message_.subscribemessage.md index 14589e9e..7a912245 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/bce17d7/src/message.ts#L37)* +*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/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/bce17d7/src/message.ts#L39)* +*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/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/bce17d7/src/message.ts#L38)* +*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L38)* diff --git a/docs/interfaces/_message_.subscribepayload.md b/docs/interfaces/_message_.subscribepayload.md index 1acf157f..649d2e55 100644 --- a/docs/interfaces/_message_.subscribepayload.md +++ b/docs/interfaces/_message_.subscribepayload.md @@ -20,7 +20,7 @@ • **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)* ___ @@ -28,7 +28,7 @@ ___ • **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)* ___ @@ -36,4 +36,4 @@ ___ • **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)* diff --git a/docs/interfaces/_server_.context.md b/docs/interfaces/_server_.context.md index 6a0327c2..ec7f8418 100644 --- a/docs/interfaces/_server_.context.md +++ b/docs/interfaces/_server_.context.md @@ -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 @@ -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 @@ -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. @@ -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. @@ -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. @@ -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**, diff --git a/docs/interfaces/_server_.server.md b/docs/interfaces/_server_.server.md index 416abb7a..249a5003 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/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. @@ -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)* diff --git a/docs/interfaces/_server_.serveroptions.md b/docs/interfaces/_server_.serveroptions.md index c371dd31..396ac2b9 100644 --- a/docs/interfaces/_server_.serveroptions.md +++ b/docs/interfaces/_server_.serveroptions.md @@ -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) @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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. diff --git a/docs/interfaces/_types_.disposable.md b/docs/interfaces/_types_.disposable.md index 71b1679e..55c794dd 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/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. diff --git a/docs/interfaces/_types_.sink.md b/docs/interfaces/_types_.sink.md index b95de9d3..be4a16fb 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/bce17d7/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L29)* The sink has completed. This function "closes" the sink. @@ -36,9 +36,9 @@ ___ ### error -▸ **error**(`error`: Error | CloseEvent | keyof GraphQLError[]): *void* +▸ **error**(`error`: Error | CloseEvent | readonly GraphQLError[]): *void* -*Defined in [types.ts:27](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L27)* An error that has occured. Calling this function "closes" the sink. @@ -46,7 +46,7 @@ An error that has occured. Calling this function "closes" the sink. Name | Type | ------ | ------ | -`error` | Error | CloseEvent | keyof GraphQLError[] | +`error` | Error | CloseEvent | readonly GraphQLError[] | **Returns:** *void* @@ -56,7 +56,7 @@ ___ ▸ **next**(`value`: T): *void* -*Defined in [types.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L25)* Next value arriving. diff --git a/docs/modules/_client_.md b/docs/modules/_client_.md index 80ec2f05..2cc7b593 100644 --- a/docs/modules/_client_.md +++ b/docs/modules/_client_.md @@ -19,7 +19,7 @@ ▸ **createClient**(`options`: [ClientOptions](../interfaces/_client_.clientoptions.md)): *[Client](../interfaces/_client_.client.md)* -*Defined in [client.ts:137](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/client.ts#L137)* +*Defined in [client.ts:137](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/client.ts#L137)* Creates a disposable GQL subscriptions client. diff --git a/docs/modules/_message_.md b/docs/modules/_message_.md index 0329d1ca..5f2bcbf5 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/bce17d7/src/message.ts#L65)* +*Defined in [message.ts:65](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L65)* diff --git a/docs/modules/_protocol_.md b/docs/modules/_protocol_.md index da9505af..7010c9e6 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/bce17d7/src/protocol.ts#L8)* +*Defined in [protocol.ts:8](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/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 6a9c80c4..1231f187 100644 --- a/docs/modules/_server_.md +++ b/docs/modules/_server_.md @@ -24,7 +24,7 @@ Ƭ **ExecutionResultFormatter**: *function* -*Defined in [server.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L40)* +*Defined in [server.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L40)* #### 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:187](https://github.com/enisdenjo/graphql-transport-ws/blob/bce17d7/src/server.ts#L187)* +*Defined in [server.ts:187](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L187)* 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 f1c8ba1c..8d7985ee 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/bce17d7/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L13)* UUID v4 string type alias generated through the `generateUUID` function from the client. diff --git a/package.json b/package.json index cd3e5f09..53a72ca2 100644 --- a/package.json +++ b/package.json @@ -74,7 +74,7 @@ "jest": "^26.4.2", "prettier": "^2.1.1", "semantic-release": "^17.1.1", - "typedoc": "^0.18.0", + "typedoc": "^0.19.0", "typedoc-plugin-markdown": "^2.4.2", "typescript": "^4.0.2" } diff --git a/yarn.lock b/yarn.lock index a762d4e8..10fe5237 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1246,7 +1246,7 @@ __metadata: jest: ^26.4.2 prettier: ^2.1.1 semantic-release: ^17.1.1 - typedoc: ^0.18.0 + typedoc: ^0.19.0 typedoc-plugin-markdown: ^2.4.2 typescript: ^4.0.2 ws: ^7.3.1 @@ -6859,7 +6859,7 @@ fsevents@^2.1.2: languageName: node linkType: hard -"lodash@npm:^4.17.14, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.4": +"lodash@npm:^4.17.14, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.20, lodash@npm:^4.17.4": version: 4.17.20 resolution: "lodash@npm:4.17.20" checksum: c62101d2500c383b5f174a7e9e6fe8098149ddd6e9ccfa85f36d4789446195f5c4afd3cfba433026bcaf3da271256566b04a2bf2618e5a39f6e67f8c12030cb6 @@ -6912,7 +6912,7 @@ fsevents@^2.1.2: languageName: node linkType: hard -"lunr@npm:^2.3.8": +"lunr@npm:^2.3.9": version: 2.3.9 resolution: "lunr@npm:2.3.9" checksum: a2b66320c2f6632322b91c43621eed9e623c0f1b81e7c2d74c238884a02229698baa4478bd238e9b32d7abf0db5ae9233b311c28e1edbcc481774e1ce83bec6f @@ -10326,12 +10326,12 @@ fsevents@^2.1.2: languageName: node linkType: hard -"typedoc-default-themes@npm:^0.10.2": - version: 0.10.2 - resolution: "typedoc-default-themes@npm:0.10.2" +"typedoc-default-themes@npm:^0.11.1": + version: 0.11.1 + resolution: "typedoc-default-themes@npm:0.11.1" dependencies: - lunr: ^2.3.8 - checksum: 8766471937395067504b3f21edd8c9f89e6901c2912aff0b4371a5dfceea31e4a1f9d08282c2998d0bc0a70e3d6943b3043ebe90e6b11dfdaf52c4a05e32d980 + lunr: ^2.3.9 + checksum: a83a1984d64c3d64e60d29e0fb9e82bcd25d80a2d1949e3788eda9dbd6473d55bc8bb9c34a590725d7910ab86bce5e9a41a85480122ad6d65492b431a75f7458 languageName: node linkType: hard @@ -10347,25 +10347,25 @@ fsevents@^2.1.2: languageName: node linkType: hard -"typedoc@npm:^0.18.0": - version: 0.18.0 - resolution: "typedoc@npm:0.18.0" +"typedoc@npm:^0.19.0": + version: 0.19.0 + resolution: "typedoc@npm:0.19.0" dependencies: fs-extra: ^9.0.1 handlebars: ^4.7.6 highlight.js: ^10.0.0 - lodash: ^4.17.15 - lunr: ^2.3.8 + lodash: ^4.17.20 + lunr: ^2.3.9 marked: ^1.1.1 minimatch: ^3.0.0 progress: ^2.0.3 shelljs: ^0.8.4 - typedoc-default-themes: ^0.10.2 + typedoc-default-themes: ^0.11.1 peerDependencies: - typescript: ">=3.8.3" + typescript: ">=4.0.2" bin: typedoc: bin/typedoc - checksum: 74abaec6601e823c29805cb0edf709329cf6ffe8189be50eab5b939bff502de535f1dc0be60f425000cf8d9246cdec65c5cde898b240a97bcb10461f37430393 + checksum: a0e704959e6578a1caeee459cc8b304ee7c08a066445a4b2ef3eb8a149c143ae03581a9b431a786957c32bd983b32fa0657ef67f8cf1df86645377cd6418c828 languageName: node linkType: hard