Skip to content

Commit

Permalink
chore(deps): update and migrate
Browse files Browse the repository at this point in the history
  • Loading branch information
enisdenjo committed May 12, 2021
1 parent c6becd2 commit 1db05ff
Show file tree
Hide file tree
Showing 19 changed files with 305 additions and 311 deletions.
12 changes: 6 additions & 6 deletions docs/interfaces/client.client-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Hierarchy

* [*Disposable*](common.disposable.md)
- [*Disposable*](common.disposable.md)

**Client**

Expand All @@ -29,7 +29,7 @@

Dispose of the instance and clear up resources.

#### Type declaration:
#### Type declaration

▸ (): *void* \| *Promise*<void\>

Expand All @@ -45,13 +45,13 @@ Inherited from: [Disposable](common.disposable.md).[dispose](common.disposable.m

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

#### Type parameters:
#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | [*Event*](../modules/client.md#event) |

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -70,13 +70,13 @@ Subscribes through the WebSocket following the config parameters. It
uses the `sink` to emit received data or errors. Returns a _cleanup_
function used for dropping the subscription and cleaning stuff up.

#### Type parameters:
#### Type parameters

| Name | Default |
| :------ | :------ |
| `T` | *unknown* |

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
14 changes: 7 additions & 7 deletions docs/interfaces/client.clientoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ in case you need more uniqueness.

Reference: https://gist.github.com/jed/982883

#### Type declaration:
#### Type declaration

▸ (): *string*

Expand All @@ -80,11 +80,11 @@ option.

**`default`** Non close events

#### Type declaration:
#### Type declaration

▸ (`errOrCloseEvent`: *unknown*): *boolean*

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -174,11 +174,11 @@ fatal by nature.

**`default`** console.error

#### Type declaration:
#### Type declaration

▸ (`errorOrCloseEvent`: *unknown*): *void*

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -219,11 +219,11 @@ by timing the resolution of the returned promise with the retries count.

**`default`** Randomised exponential backoff

#### Type declaration:
#### Type declaration

▸ (`retries`: *number*): *Promise*<void\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/common.disposable.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Hierarchy

* **Disposable**
- **Disposable**

[*Client*](client.client-1.md)

Expand All @@ -24,7 +24,7 @@

Dispose of the instance and clear up resources.

#### Type declaration:
#### Type declaration

▸ (): *void* \| *Promise*<void\>

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/common.sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ can also be a `CloseEvent`, but to avoid bundling DOM typings because
the client can run in Node env too, you should assert the close event
type during implementation.

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -58,7 +58,7 @@ ___

Next value arriving.

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/server.server-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ has been closed, for whatever reason. The close code and reason
must be passed for reporting to the `onDisconnect` callback. Returned
promise will resolve once the internal cleanup is complete.

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
46 changes: 23 additions & 23 deletions docs/interfaces/server.serveroptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`args`: ExecutionArgs): [*OperationResult*](../modules/server.md#operationresult)

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -138,11 +138,11 @@ be called, regardless if the user succesfully went through
the connection initialisation or not. `onConnect` might not
called before the `onClose`.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `code`: *number*, `reason`: *string*): *void* \| *Promise*<void\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -170,11 +170,11 @@ Since the library makes sure to complete streaming
operations even after an abrupt closure, this callback
will still be called.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `message`: [*CompleteMessage*](common.completemessage.md)): *void* \| *Promise*<void\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -212,11 +212,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>): *boolean* \| *void* \| *Record*<string, unknown\> \| *Promise*<boolean \| void \| Record<string, unknown\>\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -245,11 +245,11 @@ is acknowledged. Meaning, `onConnect` will be called before the `onDisconnect`.
For tracking socket closures at any point in time, regardless
of the connection state - consider using the `onClose` callback.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `code`: *number*, `reason`: *string*): *void* \| *Promise*<void\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -277,11 +277,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `message`: [*ErrorMessage*](common.errormessage.md), `errors`: readonly *GraphQLError*[]): *void* \| readonly *GraphQLError*[] \| *Promise*<void \| readonly *GraphQLError*[]\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -310,11 +310,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `message`: [*NextMessage*](common.nextmessage.md), `args`: ExecutionArgs, `result`: *ExecutionResult*<{ [key: string]: *any*; }, { [key: string]: *any*; }\>): *void* \| *ExecutionResult*<{ [key: string]: *any*; }, { [key: string]: *any*; }\> \| *Promise*<void \| ExecutionResult<{ [key: string]: *any*; }, { [key: string]: *any*; }\>\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -350,11 +350,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `message`: [*SubscribeMessage*](common.subscribemessage.md), `args`: ExecutionArgs, `result`: [*OperationResult*](../modules/server.md#operationresult)): *void* \| [*OperationResult*](../modules/server.md#operationresult) \| *Promise*<void \| [*OperationResult*](../modules/server.md#operationresult)\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -399,11 +399,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`ctx`: [*Context*](server.context.md)<E\>, `message`: [*SubscribeMessage*](common.subscribemessage.md)): *void* \| readonly *GraphQLError*[] \| ExecutionArgs \| *Promise*<void \| readonly *GraphQLError*[] \| ExecutionArgs\>

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -426,7 +426,7 @@ If you return from `onSubscribe`, and the returned value is
missing the `rootValue` field, the relevant operation root
will be used instead.

#### Type declaration:
#### Type declaration

| Name | Type |
| :------ | :------ |
Expand Down Expand Up @@ -468,11 +468,11 @@ Throwing an error from within this function will
close the socket with the `Error` message
in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`args`: ExecutionArgs): [*OperationResult*](../modules/server.md#operationresult)

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -498,11 +498,11 @@ Will not be used when implementing a custom `onSubscribe`.
Throwing an error from within this function will close the socket
with the `Error` message in the close event reason.

#### Type declaration:
#### Type declaration

▸ (`schema`: *GraphQLSchema*, `documentAST`: DocumentNode, `rules?`: readonly ValidationRule[], `typeInfo?`: *TypeInfo*, `options?`: { `maxErrors?`: *number* }): readonly *GraphQLError*[]

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/server.websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ callback will be called.
The returned promise is used to control the graceful
closure.

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -65,7 +65,7 @@ Exceptions raised during any phase of operation processing will
reject the callback's promise, catch them and communicate them
to your clients however you wish.

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand All @@ -89,7 +89,7 @@ method of the `Server`.
The returned promise is used to control the flow of data
(like handling backpressure).

#### Parameters:
#### Parameters

| Name | Type |
| :------ | :------ |
Expand Down
Loading

0 comments on commit 1db05ff

Please sign in to comment.