Skip to content

Commit d2672e3

Browse files
authored
feat: update docs and deps (#144)
1 parent 7b51d3c commit d2672e3

File tree

8 files changed

+326
-303
lines changed

8 files changed

+326
-303
lines changed

docs/.nojekyll

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ ___
8888

8989
| Name | Type |
9090
| :------ | :------ |
91-
| `TSubscribeArgs` | extends [`SubscribeArgs`](README.md#subscribeargs)[`SubscribeArgs`](README.md#subscribeargs) |
92-
| `TReturn` | extends `Record`<`string`, `any`\>`Record`<`string`, `any`\> |
91+
| `TSubscribeArgs` | extends [`SubscribeArgs`](README.md#subscribeargs) = [`SubscribeArgs`](README.md#subscribeargs) |
92+
| `TReturn` | extends `Record`<`string`, `any`\> = `Record`<`string`, `any`\> |
9393

9494
___
9595

@@ -136,9 +136,9 @@ Creates subscribe handler for use in your graphql schema.
136136
| Name | Type |
137137
| :------ | :------ |
138138
| `T` | extends [`PubSubEvent`](interfaces/PubSubEvent.md) |
139-
| `TRoot` | extends `unknown``any` |
140-
| `TArgs` | extends `Record`<`string`, `any`\>`any` |
141-
| `TContext` | extends `unknown``any` |
139+
| `TRoot` | extends `unknown` = `any` |
140+
| `TArgs` | extends `Record`<`string`, `any`\> = `any` |
141+
| `TContext` | extends `unknown` = `any` |
142142

143143
#### Parameters
144144

docs/interfaces/ServerArgs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ ___
5757

5858
### pingpong
5959

60-
`Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<`Object`\>
60+
`Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<{ `delay`: `number` ; `machine`: `string` ; `timeout`: `number` }\>
6161

6262
If set you can use the `stepFunctionsHandler` and a step function to setup a per connection ping/pong cycle to detect disconnects sooner than the 10 minute idle timeout.
6363

@@ -81,7 +81,7 @@ ___
8181

8282
### tableNames
8383

84-
`Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<`Object`\>
84+
`Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<{ `connections?`: `string` ; `subscriptions?`: `string` }\>
8585

8686
An optional object or a promise for an object with DDB table names.
8787

docs/interfaces/SubscribeOptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| Name | Type |
88
| :------ | :------ |
99
| `T` | extends [`PubSubEvent`](PubSubEvent.md) |
10-
| `TSubscribeArgs` | extends [`SubscribeArgs`](../README.md#subscribeargs)[`SubscribeArgs`](../README.md#subscribeargs) |
10+
| `TSubscribeArgs` | extends [`SubscribeArgs`](../README.md#subscribeargs) = [`SubscribeArgs`](../README.md#subscribeargs) |
1111

1212
## Table of contents
1313

docs/interfaces/SubscribePseudoIterable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| Name | Type |
88
| :------ | :------ |
99
| `T` | extends [`PubSubEvent`](PubSubEvent.md) |
10-
| `TSubscribeArgs` | extends [`SubscribeArgs`](../README.md#subscribeargs)[`SubscribeArgs`](../README.md#subscribeargs) |
10+
| `TSubscribeArgs` | extends [`SubscribeArgs`](../README.md#subscribeargs) = [`SubscribeArgs`](../README.md#subscribeargs) |
1111

1212
## Callable
1313

mocks/arc-basic-events/lib/graphql.js

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ const typeDefs = `
2525
const resolvers = {
2626
Query: {
2727
hello: () => 'Hello World!',
28+
// eslint-disable-next-line @typescript-eslint/no-empty-function
2829
dontResolve: () => new Promise(() => {}),
2930
},
3031
Subscription: {

0 commit comments

Comments
 (0)