diff --git a/README.md b/README.md index 9abad46d..37ad2404 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ ### Install ```shell -yarn add @enisdenjo/graphql-transport-ws +yarn add graphql-transport-ws # or -npm install @enisdenjo/graphql-transport-ws +npm install graphql-transport-ws ``` ### Examples @@ -18,7 +18,7 @@ npm install @enisdenjo/graphql-transport-ws ```ts import { Network, Observable } from 'relay-runtime'; -import { createClient } from '@enisdenjo/graphql-transport-ws'; +import { createClient } from 'graphql-transport-ws'; const subscriptionsClient = createClient({ url: 'wss://some.url/graphql', @@ -83,7 +83,7 @@ export const network = Network.create( ```typescript import { ApolloLink, Operation, FetchResult, Observable } from '@apollo/client'; -import { createClient, Config, Client } from '@enisdenjo/graphql-transport-ws'; +import { createClient, Config, Client } from 'graphql-transport-ws'; class WebSocketLink extends ApolloLink { private client: Client; diff --git a/docs/README.md b/docs/README.md index 9811382d..b10c958c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -[@enisdenjo/graphql-transport-ws](README.md) +[graphql-transport-ws](README.md) -# @enisdenjo/graphql-transport-ws +# graphql-transport-ws ## Index diff --git a/docs/enums/_message_.messagetype.md b/docs/enums/_message_.messagetype.md index 61e16d83..8ab8663b 100644 --- a/docs/enums/_message_.messagetype.md +++ b/docs/enums/_message_.messagetype.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [MessageType](_message_.messagetype.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [MessageType](_message_.messagetype.md) # Enumeration: MessageType @@ -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/9a98ec4/src/message.ts#L24)* +*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L24)* ___ @@ -29,7 +29,7 @@ ___ • **ConnectionAck**: = "connection_ack" -*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L19)* +*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L19)* ___ @@ -37,7 +37,7 @@ ___ • **ConnectionInit**: = "connection_init" -*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L18)* +*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L18)* ___ @@ -45,7 +45,7 @@ ___ • **Error**: = "error" -*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L23)* +*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L23)* ___ @@ -53,7 +53,7 @@ ___ • **Next**: = "next" -*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L22)* +*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L22)* ___ @@ -61,4 +61,4 @@ ___ • **Subscribe**: = "subscribe" -*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L21)* +*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L21)* diff --git a/docs/interfaces/_client_.client.md b/docs/interfaces/_client_.client.md index 8dc2b03a..0cae2b7b 100644 --- a/docs/interfaces/_client_.client.md +++ b/docs/interfaces/_client_.client.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["client"](../modules/_client_.md) › [Client](_client_.client.md) +[graphql-transport-ws](../README.md) › ["client"](../modules/_client_.md) › [Client](_client_.client.md) # Interface: Client @@ -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/9a98ec4/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/client.ts#L33)* +*Defined in [client.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 b36219d4..ea302e9f 100644 --- a/docs/interfaces/_client_.clientoptions.md +++ b/docs/interfaces/_client_.clientoptions.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["client"](../modules/_client_.md) › [ClientOptions](_client_.clientoptions.md) +[graphql-transport-ws](../README.md) › ["client"](../modules/_client_.md) › [ClientOptions](_client_.clientoptions.md) # Interface: ClientOptions @@ -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/9a98ec4/src/client.ts#L24)* +*Defined in [client.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/client.ts#L22)* +*Defined in [client.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 f2ab0f65..e57acf3c 100644 --- a/docs/interfaces/_message_.completemessage.md +++ b/docs/interfaces/_message_.completemessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [CompleteMessage](_message_.completemessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [CompleteMessage](_message_.completemessage.md) # Interface: CompleteMessage @@ -19,7 +19,7 @@ • **id**: *string* -*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L61)* +*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L62)* +*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L62)* diff --git a/docs/interfaces/_message_.connectionackmessage.md b/docs/interfaces/_message_.connectionackmessage.md index 48543f8c..b422c7c9 100644 --- a/docs/interfaces/_message_.connectionackmessage.md +++ b/docs/interfaces/_message_.connectionackmessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ConnectionAckMessage](_message_.connectionackmessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ConnectionAckMessage](_message_.connectionackmessage.md) # Interface: ConnectionAckMessage @@ -18,4 +18,4 @@ • **type**: *[ConnectionAck](../enums/_message_.messagetype.md#connectionack)* -*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L33)* +*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L33)* diff --git a/docs/interfaces/_message_.connectioninitmessage.md b/docs/interfaces/_message_.connectioninitmessage.md index 091fd534..82813b1d 100644 --- a/docs/interfaces/_message_.connectioninitmessage.md +++ b/docs/interfaces/_message_.connectioninitmessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ConnectionInitMessage](_message_.connectioninitmessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ConnectionInitMessage](_message_.connectioninitmessage.md) # Interface: ConnectionInitMessage @@ -19,7 +19,7 @@ • **payload**? : *Record‹string, unknown›* -*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L29)* +*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L28)* +*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L28)* diff --git a/docs/interfaces/_message_.errormessage.md b/docs/interfaces/_message_.errormessage.md index 12cb9788..aa9e5980 100644 --- a/docs/interfaces/_message_.errormessage.md +++ b/docs/interfaces/_message_.errormessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ErrorMessage](_message_.errormessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [ErrorMessage](_message_.errormessage.md) # Interface: ErrorMessage @@ -20,7 +20,7 @@ • **id**: *string* -*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L55)* +*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L55)* ___ @@ -28,7 +28,7 @@ ___ • **payload**: *readonly GraphQLError[]* -*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L57)* +*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L56)* +*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L56)* diff --git a/docs/interfaces/_message_.nextmessage.md b/docs/interfaces/_message_.nextmessage.md index 63cbfe6b..302aa2f5 100644 --- a/docs/interfaces/_message_.nextmessage.md +++ b/docs/interfaces/_message_.nextmessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [NextMessage](_message_.nextmessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [NextMessage](_message_.nextmessage.md) # Interface: NextMessage @@ -20,7 +20,7 @@ • **id**: *string* -*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L49)* +*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L49)* ___ @@ -28,7 +28,7 @@ ___ • **payload**: *ExecutionResult* -*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L51)* +*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L50)* +*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L50)* diff --git a/docs/interfaces/_message_.subscribemessage.md b/docs/interfaces/_message_.subscribemessage.md index 7a912245..43c4db11 100644 --- a/docs/interfaces/_message_.subscribemessage.md +++ b/docs/interfaces/_message_.subscribemessage.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [SubscribeMessage](_message_.subscribemessage.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [SubscribeMessage](_message_.subscribemessage.md) # Interface: SubscribeMessage @@ -20,7 +20,7 @@ • **id**: *string* -*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L37)* +*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L39)* +*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L38)* +*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L38)* diff --git a/docs/interfaces/_message_.subscribepayload.md b/docs/interfaces/_message_.subscribepayload.md index 649d2e55..436c30d5 100644 --- a/docs/interfaces/_message_.subscribepayload.md +++ b/docs/interfaces/_message_.subscribepayload.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [SubscribePayload](_message_.subscribepayload.md) +[graphql-transport-ws](../README.md) › ["message"](../modules/_message_.md) › [SubscribePayload](_message_.subscribepayload.md) # Interface: SubscribePayload @@ -20,7 +20,7 @@ • **operationName**: *string* -*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L43)* +*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L43)* ___ @@ -28,7 +28,7 @@ ___ • **query**: *string | DocumentNode* -*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/message.ts#L44)* +*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/message.ts#L45)* +*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L45)* diff --git a/docs/interfaces/_server_.context.md b/docs/interfaces/_server_.context.md index ec7f8418..a560ba21 100644 --- a/docs/interfaces/_server_.context.md +++ b/docs/interfaces/_server_.context.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [Context](_server_.context.md) +[graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [Context](_server_.context.md) # Interface: Context @@ -23,7 +23,7 @@ • **acknowledged**: *boolean* -*Defined in [server.ts:163](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L163)* +*Defined in [server.ts:163](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L157)* +*Defined in [server.ts:157](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L165)* +*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L150)* +*Defined in [server.ts:150](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L145)* +*Defined in [server.ts:145](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L171)* +*Defined in [server.ts:171](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 249a5003..2cbf535a 100644 --- a/docs/interfaces/_server_.server.md +++ b/docs/interfaces/_server_.server.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [Server](_server_.server.md) +[graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [Server](_server_.server.md) # Interface: Server @@ -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/9a98ec4/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L175)* +*Defined in [server.ts:175](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/server.ts#L175)* diff --git a/docs/interfaces/_server_.serveroptions.md b/docs/interfaces/_server_.serveroptions.md index 396ac2b9..e5347c26 100644 --- a/docs/interfaces/_server_.serveroptions.md +++ b/docs/interfaces/_server_.serveroptions.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [ServerOptions](_server_.serveroptions.md) +[graphql-transport-ws](../README.md) › ["server"](../modules/_server_.md) › [ServerOptions](_server_.serveroptions.md) # Interface: ServerOptions @@ -26,7 +26,7 @@ • **connectionInitWaitTimeout**? : *undefined | number* -*Defined in [server.ts:104](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L104)* +*Defined in [server.ts:104](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L60)* +*Defined in [server.ts:60](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L116)* +*Defined in [server.ts:116](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L138)* +*Defined in [server.ts:138](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L90)* +*Defined in [server.ts:90](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L126)* +*Defined in [server.ts:126](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L53)* +*Defined in [server.ts:53](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L67)* +*Defined in [server.ts:67](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/server.ts#L67)* Is the `subscribe` function from GraphQL which is used to @@ -174,7 +174,7 @@ ___ • **validationRules**? : *readonly ValidationRule[]* -*Defined in [server.ts:109](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L109)* +*Defined in [server.ts:109](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 55c794dd..71496db6 100644 --- a/docs/interfaces/_types_.disposable.md +++ b/docs/interfaces/_types_.disposable.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["types"](../modules/_types_.md) › [Disposable](_types_.disposable.md) +[graphql-transport-ws](../README.md) › ["types"](../modules/_types_.md) › [Disposable](_types_.disposable.md) # Interface: Disposable @@ -22,7 +22,7 @@ • **dispose**: *function* -*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 be4a16fb..e9893ef7 100644 --- a/docs/interfaces/_types_.sink.md +++ b/docs/interfaces/_types_.sink.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["types"](../modules/_types_.md) › [Sink](_types_.sink.md) +[graphql-transport-ws](../README.md) › ["types"](../modules/_types_.md) › [Sink](_types_.sink.md) # Interface: Sink ‹**T**› @@ -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/9a98ec4/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/types.ts#L25)* Next value arriving. diff --git a/docs/modules/_client_.md b/docs/modules/_client_.md index 2cc7b593..71a2474d 100644 --- a/docs/modules/_client_.md +++ b/docs/modules/_client_.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["client"](_client_.md) +[graphql-transport-ws](../README.md) › ["client"](_client_.md) # Module: "client" @@ -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/9a98ec4/src/client.ts#L137)* +*Defined in [client.ts:137](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/client.ts#L137)* Creates a disposable GQL subscriptions client. diff --git a/docs/modules/_message_.md b/docs/modules/_message_.md index 5f2bcbf5..fcf9f01c 100644 --- a/docs/modules/_message_.md +++ b/docs/modules/_message_.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["message"](_message_.md) +[graphql-transport-ws](../README.md) › ["message"](_message_.md) # Module: "message" @@ -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/9a98ec4/src/message.ts#L65)* +*Defined in [message.ts:65](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L65)* diff --git a/docs/modules/_protocol_.md b/docs/modules/_protocol_.md index 7010c9e6..dd49c73d 100644 --- a/docs/modules/_protocol_.md +++ b/docs/modules/_protocol_.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["protocol"](_protocol_.md) +[graphql-transport-ws](../README.md) › ["protocol"](_protocol_.md) # Module: "protocol" @@ -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/9a98ec4/src/protocol.ts#L8)* +*Defined in [protocol.ts:8](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 1231f187..431cd4ff 100644 --- a/docs/modules/_server_.md +++ b/docs/modules/_server_.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["server"](_server_.md) +[graphql-transport-ws](../README.md) › ["server"](_server_.md) # Module: "server" @@ -24,7 +24,7 @@ Ƭ **ExecutionResultFormatter**: *function* -*Defined in [server.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/server.ts#L40)* +*Defined in [server.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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/9a98ec4/src/server.ts#L187)* +*Defined in [server.ts:187](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 8d7985ee..966b0e29 100644 --- a/docs/modules/_types_.md +++ b/docs/modules/_types_.md @@ -1,4 +1,4 @@ -[@enisdenjo/graphql-transport-ws](../README.md) › ["types"](_types_.md) +[graphql-transport-ws](../README.md) › ["types"](_types_.md) # Module: "types" @@ -19,7 +19,7 @@ Ƭ **UUID**: *string* -*Defined in [types.ts:13](https://github.com/enisdenjo/graphql-transport-ws/blob/9a98ec4/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/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 53a72ca2..1ea18078 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@enisdenjo/graphql-transport-ws", + "name": "graphql-transport-ws", "version": "1.1.1", "description": "🔗 A coherent, zero-dependency, lazy, simple and easy to use server and client implementation for GraphQL over WebSocket.", "keywords": [ diff --git a/yarn.lock b/yarn.lock index 10fe5237..0aadb4df 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1220,41 +1220,6 @@ __metadata: languageName: node linkType: hard -"@enisdenjo/graphql-transport-ws@workspace:.": - version: 0.0.0-use.local - resolution: "@enisdenjo/graphql-transport-ws@workspace:." - dependencies: - "@babel/core": ^7.11.4 - "@babel/plugin-proposal-class-properties": ^7.10.4 - "@babel/plugin-proposal-nullish-coalescing-operator": ^7.10.4 - "@babel/plugin-proposal-object-rest-spread": ^7.11.0 - "@babel/plugin-proposal-optional-chaining": ^7.11.0 - "@babel/preset-env": ^7.11.0 - "@babel/preset-typescript": ^7.10.4 - "@semantic-release/changelog": ^5.0.1 - "@semantic-release/git": ^9.0.0 - "@types/jest": ^26.0.10 - "@types/ws": ^7.2.6 - "@typescript-eslint/eslint-plugin": ^3.10.1 - "@typescript-eslint/parser": ^3.10.1 - babel-jest: ^26.3.0 - eslint: ^7.7.0 - eslint-config-prettier: ^6.11.0 - eslint-plugin-prettier: ^3.1.4 - graphql: ^15.3.0 - graphql-subscriptions: ^1.1.0 - jest: ^26.4.2 - prettier: ^2.1.1 - semantic-release: ^17.1.1 - typedoc: ^0.19.0 - typedoc-plugin-markdown: ^2.4.2 - typescript: ^4.0.2 - ws: ^7.3.1 - peerDependencies: - graphql: ">=15.0.0" - languageName: unknown - linkType: soft - "@iarna/cli@npm:^1.2.0": version: 1.2.0 resolution: "@iarna/cli@npm:1.2.0" @@ -4817,6 +4782,41 @@ fsevents@^2.1.2: languageName: node linkType: hard +"graphql-transport-ws@workspace:.": + version: 0.0.0-use.local + resolution: "graphql-transport-ws@workspace:." + dependencies: + "@babel/core": ^7.11.4 + "@babel/plugin-proposal-class-properties": ^7.10.4 + "@babel/plugin-proposal-nullish-coalescing-operator": ^7.10.4 + "@babel/plugin-proposal-object-rest-spread": ^7.11.0 + "@babel/plugin-proposal-optional-chaining": ^7.11.0 + "@babel/preset-env": ^7.11.0 + "@babel/preset-typescript": ^7.10.4 + "@semantic-release/changelog": ^5.0.1 + "@semantic-release/git": ^9.0.0 + "@types/jest": ^26.0.10 + "@types/ws": ^7.2.6 + "@typescript-eslint/eslint-plugin": ^3.10.1 + "@typescript-eslint/parser": ^3.10.1 + babel-jest: ^26.3.0 + eslint: ^7.7.0 + eslint-config-prettier: ^6.11.0 + eslint-plugin-prettier: ^3.1.4 + graphql: ^15.3.0 + graphql-subscriptions: ^1.1.0 + jest: ^26.4.2 + prettier: ^2.1.1 + semantic-release: ^17.1.1 + typedoc: ^0.19.0 + typedoc-plugin-markdown: ^2.4.2 + typescript: ^4.0.2 + ws: ^7.3.1 + peerDependencies: + graphql: ">=15.0.0" + languageName: unknown + linkType: soft + "graphql@npm:^15.3.0": version: 15.3.0 resolution: "graphql@npm:15.3.0"