Skip to content

Commit e6dae90

Browse files
committed
docs: generate [skip ci]
1 parent 757c6e9 commit e6dae90

20 files changed

+66
-66
lines changed

docs/enums/_message_.messagetype.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -21,44 +21,44 @@ Types of messages allowed to be sent by the client/server over the WS protocol.
2121

2222
**Complete**: = "complete"
2323

24-
*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L24)*
24+
*Defined in [message.ts:24](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L24)*
2525

2626
___
2727

2828
### ConnectionAck
2929

3030
**ConnectionAck**: = "connection_ack"
3131

32-
*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L19)*
32+
*Defined in [message.ts:19](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L19)*
3333

3434
___
3535

3636
### ConnectionInit
3737

3838
**ConnectionInit**: = "connection_init"
3939

40-
*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L18)*
40+
*Defined in [message.ts:18](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L18)*
4141

4242
___
4343

4444
### Error
4545

4646
**Error**: = "error"
4747

48-
*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L23)*
48+
*Defined in [message.ts:23](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L23)*
4949

5050
___
5151

5252
### Next
5353

5454
**Next**: = "next"
5555

56-
*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L22)*
56+
*Defined in [message.ts:22](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L22)*
5757

5858
___
5959

6060
### Subscribe
6161

6262
**Subscribe**: = "subscribe"
6363

64-
*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L21)*
64+
*Defined in [message.ts:21](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L21)*

docs/interfaces/_client_.client.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
*Inherited from [Disposable](_types_.disposable.md).[dispose](_types_.disposable.md#dispose)*
2929

30-
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/types.ts#L17)*
30+
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L17)*
3131

3232
Dispose of the instance and clear up resources.
3333

@@ -41,7 +41,7 @@ Dispose of the instance and clear up resources.
4141

4242
**on****E**›(`event`: E, `listener`: [EventListener](../modules/_client_.md#eventlistener)‹E›): *function*
4343

44-
*Defined in [client.ts:69](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L69)*
44+
*Defined in [client.ts:70](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L70)*
4545

4646
Listens on the client which dispatches events about the socket state.
4747

@@ -66,7 +66,7 @@ ___
6666

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

69-
*Defined in [client.ts:75](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L75)*
69+
*Defined in [client.ts:76](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L76)*
7070

7171
Subscribes through the WebSocket following the config parameters. It
7272
uses the `sink` to emit received data or errors. Returns a _cleanup_

docs/interfaces/_client_.clientoptions.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Configuration used for the `create` client function.
2525

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

28-
*Defined in [client.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L39)*
28+
*Defined in [client.ts:40](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L40)*
2929

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

@@ -35,7 +35,7 @@ ___
3535

3636
**lazy**? : *undefined | false | true*
3737

38-
*Defined in [client.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L45)*
38+
*Defined in [client.ts:46](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L46)*
3939

4040
Should the connection be established immediately and persisted
4141
or after the first listener subscribed.
@@ -48,7 +48,7 @@ ___
4848

4949
**on**? : *Partial‹object›*
5050

51-
*Defined in [client.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L62)*
51+
*Defined in [client.ts:63](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L63)*
5252

5353
Register listeners before initialising the client. This way
5454
you can ensure to catch all client relevant emitted events.
@@ -61,7 +61,7 @@ ___
6161

6262
**retryAttempts**? : *undefined | number*
6363

64-
*Defined in [client.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L50)*
64+
*Defined in [client.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L51)*
6565

6666
How many times should the client try to reconnect on abnormal socket closure before it errors out?
6767

@@ -73,7 +73,7 @@ ___
7373

7474
**retryTimeout**? : *undefined | number*
7575

76-
*Defined in [client.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L55)*
76+
*Defined in [client.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L56)*
7777

7878
How long should the client wait until attempting to retry.
7979

@@ -85,6 +85,6 @@ ___
8585

8686
**url**: *string*
8787

88-
*Defined in [client.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/client.ts#L37)*
88+
*Defined in [client.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/client.ts#L38)*
8989

9090
URL of the GraphQL server to connect.

docs/interfaces/_message_.completemessage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
**id**: *string*
2121

22-
*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L61)*
22+
*Defined in [message.ts:61](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L61)*
2323

2424
___
2525

2626
### `Readonly` type
2727

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

30-
*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L62)*
30+
*Defined in [message.ts:62](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L62)*

docs/interfaces/_message_.connectionackmessage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818

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

21-
*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L33)*
21+
*Defined in [message.ts:33](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L33)*

docs/interfaces/_message_.connectioninitmessage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

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

22-
*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L29)*
22+
*Defined in [message.ts:29](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L29)*
2323

2424
___
2525

2626
### `Readonly` type
2727

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

30-
*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L28)*
30+
*Defined in [message.ts:28](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L28)*

docs/interfaces/_message_.errormessage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020

2121
**id**: *string*
2222

23-
*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L55)*
23+
*Defined in [message.ts:55](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L55)*
2424

2525
___
2626

2727
### `Readonly` payload
2828

2929
**payload**: *readonly GraphQLError[]*
3030

31-
*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L57)*
31+
*Defined in [message.ts:57](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L57)*
3232

3333
___
3434

3535
### `Readonly` type
3636

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

39-
*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L56)*
39+
*Defined in [message.ts:56](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L56)*

docs/interfaces/_message_.nextmessage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020

2121
**id**: *string*
2222

23-
*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L49)*
23+
*Defined in [message.ts:49](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L49)*
2424

2525
___
2626

2727
### `Readonly` payload
2828

2929
**payload**: *ExecutionResult*
3030

31-
*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L51)*
31+
*Defined in [message.ts:51](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L51)*
3232

3333
___
3434

3535
### `Readonly` type
3636

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

39-
*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L50)*
39+
*Defined in [message.ts:50](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L50)*

docs/interfaces/_message_.subscribemessage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020

2121
**id**: *string*
2222

23-
*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L37)*
23+
*Defined in [message.ts:37](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L37)*
2424

2525
___
2626

2727
### `Readonly` payload
2828

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

31-
*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L39)*
31+
*Defined in [message.ts:39](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L39)*
3232

3333
___
3434

3535
### `Readonly` type
3636

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

39-
*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L38)*
39+
*Defined in [message.ts:38](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L38)*

docs/interfaces/_message_.subscribepayload.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020

2121
**operationName**? : *string | null*
2222

23-
*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L43)*
23+
*Defined in [message.ts:43](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L43)*
2424

2525
___
2626

2727
### `Readonly` query
2828

2929
**query**: *string | DocumentNode*
3030

31-
*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L44)*
31+
*Defined in [message.ts:44](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L44)*
3232

3333
___
3434

3535
### `Optional` `Readonly` variables
3636

3737
**variables**? : *Record‹string, unknown› | null*
3838

39-
*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/message.ts#L45)*
39+
*Defined in [message.ts:45](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/message.ts#L45)*

docs/interfaces/_server_.context.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
**acknowledged**: *boolean*
2525

26-
*Defined in [server.ts:183](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L183)*
26+
*Defined in [server.ts:183](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L183)*
2727

2828
Indicates that the connection was acknowledged
2929
by having dispatched the `ConnectionAck` message
@@ -35,7 +35,7 @@ ___
3535

3636
**connectionInitReceived**: *boolean*
3737

38-
*Defined in [server.ts:177](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L177)*
38+
*Defined in [server.ts:177](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L177)*
3939

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

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

51-
*Defined in [server.ts:185](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L185)*
51+
*Defined in [server.ts:185](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L185)*
5252

5353
The parameters passed during the connection initialisation.
5454

@@ -58,7 +58,7 @@ ___
5858

5959
**request**: *IncomingMessage*
6060

61-
*Defined in [server.ts:170](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L170)*
61+
*Defined in [server.ts:170](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L170)*
6262

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

7070
**socket**: *WebSocket*
7171

72-
*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L165)*
72+
*Defined in [server.ts:165](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L165)*
7373

7474
The actual WebSocket connection between the server and the client.
7575

@@ -79,7 +79,7 @@ ___
7979

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

82-
*Defined in [server.ts:191](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L191)*
82+
*Defined in [server.ts:191](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L191)*
8383

8484
Holds the active subscriptions for this context.
8585
Subscriptions are for `subscription` operations **only**,

docs/interfaces/_server_.server.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
*Inherited from [Disposable](_types_.disposable.md).[dispose](_types_.disposable.md#dispose)*
2525

26-
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/types.ts#L17)*
26+
*Defined in [types.ts:17](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/types.ts#L17)*
2727

2828
Dispose of the instance and clear up resources.
2929

@@ -37,4 +37,4 @@ ___
3737

3838
**webSocketServer**: *Server*
3939

40-
*Defined in [server.ts:195](https://github.com/enisdenjo/graphql-transport-ws/blob/bb59cf9/src/server.ts#L195)*
40+
*Defined in [server.ts:195](https://github.com/enisdenjo/graphql-transport-ws/blob/757c6e9/src/server.ts#L195)*

0 commit comments

Comments
 (0)