feat: Package rename @enisdenjo/graphql-transport-ws 👉 `graphql-tra…

…nsport-ws`.
ilijaNL · Sep 4, 2020 · 494f676 · 494f676
1 parent cf71465
commit 494f676
Show file tree

Hide file tree

Showing 24 changed files with 116 additions and 116 deletions.
diff --git 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
@@ -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
@@ -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,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/9a98ec4/src/message.ts#L24)*
+*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/cf71465/src/message.ts#L24)*
 
 ___
 
 ###  ConnectionAck
 
 • **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)*
 
 ___
 
 ###  ConnectionInit
 
 • **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)*
 
 ___
 
 ###  Error
 
 • **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)*
 
 ___
 
 ###  Next
 
 • **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)*
 
 ___
 
 ###  Subscribe
 
 • **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
@@ -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
@@ -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
@@ -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,12 +19,12 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` type
 
 • **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
@@ -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
@@ -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,12 +19,12 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` type
 
 • **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
@@ -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,20 +20,20 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` payload
 
 • **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)*
 
 ___
 
 ### `Readonly` type
 
 • **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
@@ -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,20 +20,20 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` payload
 
 • **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)*
 
 ___
 
 ### `Readonly` type
 
 • **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
@@ -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,20 +20,20 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` payload
 
 • **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)*
 
 ___
 
 ### `Readonly` type
 
 • **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
@@ -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,20 +20,20 @@
 
 • **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)*
 
 ___
 
 ### `Readonly` query
 
 • **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)*
 
 ___
 
 ### `Readonly` variables
 
 • **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
@@ -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
@@ -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)*