Skip to content
This repository was archived by the owner on May 17, 2025. It is now read-only.

Commit 3b87204

Browse files
reconbotreconbot
authored
docs: update docs (#301)
1 parent de2329a commit 3b87204

11 files changed

Lines changed: 185 additions & 164 deletions

‎docs/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ graphql-lambda-subscriptions
1616
- [SubscribePseudoIterable](interfaces/SubscribePseudoIterable.md)
1717
- [SubscriptionServer](interfaces/SubscriptionServer.md)
1818

19-
### Type aliases
19+
### Type Aliases
2020

2121
- [LoggerFunction](README.md#loggerfunction)
2222
- [MaybePromise](README.md#maybepromise)
@@ -29,7 +29,7 @@ graphql-lambda-subscriptions
2929
- [makeServer](README.md#makeserver)
3030
- [subscribe](README.md#subscribe)
3131

32-
## Type aliases
32+
## Type Aliases
3333

3434
### LoggerFunction
3535

@@ -109,7 +109,7 @@ ___
109109

110110
### makeServer
111111

112-
▸ `Const` **makeServer**(`opts`): [`SubscriptionServer`](interfaces/SubscriptionServer.md)
112+
▸ **makeServer**(`opts`): [`SubscriptionServer`](interfaces/SubscriptionServer.md)
113113

114114
#### Parameters
115115

@@ -125,7 +125,7 @@ ___
125125

126126
### subscribe
127127

128-
▸ `Const` **subscribe**<`T`, `TRoot`, `TArgs`, `TContext`\>(`topic`, `options?`): [`SubscribePseudoIterable`](interfaces/SubscribePseudoIterable.md)<`T`, [`SubscribeArgs`](README.md#subscribeargs)<`TRoot`, `TArgs`, `TContext`\>\>
128+
▸ **subscribe**<`T`, `TRoot`, `TArgs`, `TContext`\>(`topic`, `options?`): [`SubscribePseudoIterable`](interfaces/SubscribePseudoIterable.md)<`T`, [`SubscribeArgs`](README.md#subscribeargs)<`TRoot`, `TArgs`, `TContext`\>\>
129129

130130
Creates subscribe handler for use in your graphql schema.
131131

‎docs/interfaces/ApiGatewayManagementApiSubset.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
| Name | Type |
3030
| :------ | :------ |
31-
| `promise` | () => `Promise`<`void`\> |
31+
| `promise` | () => `Promise`<`any`\> |
3232

3333
___
3434

@@ -50,4 +50,4 @@ ___
5050

5151
| Name | Type |
5252
| :------ | :------ |
53-
| `promise` | () => `Promise`<`void`\> |
53+
| `promise` | () => `Promise`<`any`\> |

‎docs/interfaces/ServerArgs.md‎

Lines changed: 78 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,15 @@
1010
- [context](ServerArgs.md#context)
1111
- [dynamodb](ServerArgs.md#dynamodb)
1212
- [log](ServerArgs.md#log)
13-
- [pingpong](ServerArgs.md#pingpong)
14-
- [schema](ServerArgs.md#schema)
15-
- [tableNames](ServerArgs.md#tablenames)
16-
17-
### Methods
18-
1913
- [onConnect](ServerArgs.md#onconnect)
2014
- [onConnectionInit](ServerArgs.md#onconnectioninit)
2115
- [onDisconnect](ServerArgs.md#ondisconnect)
2216
- [onError](ServerArgs.md#onerror)
2317
- [onPing](ServerArgs.md#onping)
2418
- [onPong](ServerArgs.md#onpong)
19+
- [pingpong](ServerArgs.md#pingpong)
20+
- [schema](ServerArgs.md#schema)
21+
- [tableNames](ServerArgs.md#tablenames)
2522

2623
## Properties
2724

@@ -55,139 +52,163 @@ Defaults to debug('graphql-lambda-subscriptions') from https://www.npmjs.com/pac
5552

5653
___
5754

58-
### pingpong
59-
60-
• `Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<{ `delay`: `number` ; `machine`: `string` ; `timeout`: `number` }\>
61-
62-
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.
63-
64-
___
65-
66-
### schema
67-
68-
• **schema**: `GraphQLSchema`
69-
70-
A GraphQL Schema with resolvers
71-
72-
You can use `makeExecutableSchema` from [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema), or `makeSchema` from [`nexus`](https://nexusjs.org/)
73-
74-
```ts
75-
import { makeExecutableSchema } from '@graphql-tools/schema
76-
// or
77-
import { makeSchema } from 'nexus'
78-
```
79-
80-
___
81-
82-
### tableNames
83-
84-
• `Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<{ `connections?`: `string` ; `subscriptions?`: `string` }\>
85-
86-
An optional object or a promise for an object with DDB table names.
87-
88-
Defaults to `{ connections: 'graphql_connections', subscriptions: 'graphql_subscriptions' }`
55+
### onConnect
8956

90-
## Methods
57+
• `Optional` **onConnect**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) }) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
9158

92-
### onConnect
59+
#### Type declaration
9360

94-
▸ `Optional` **onConnect**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
61+
▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
9562

96-
#### Parameters
63+
##### Parameters
9764

9865
| Name | Type |
9966
| :------ | :------ |
10067
| `e` | `Object` |
10168
| `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) |
10269

103-
#### Returns
70+
##### Returns
10471

10572
[`MaybePromise`](../README.md#maybepromise)<`void`\>
10673

10774
___
10875

10976
### onConnectionInit
11077

111-
▸ `Optional` **onConnectionInit**(`e`): [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\>
78+
• `Optional` **onConnectionInit**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `ConnectionInitMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\>
79+
80+
#### Type declaration
81+
82+
▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\>
11283

113-
#### Parameters
84+
##### Parameters
11485

11586
| Name | Type |
11687
| :------ | :------ |
11788
| `e` | `Object` |
11889
| `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) |
11990
| `e.message` | `ConnectionInitMessage` |
12091

121-
#### Returns
92+
##### Returns
12293

12394
[`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\>
12495

12596
___
12697

12798
### onDisconnect
12899

129-
▸ `Optional` **onDisconnect**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
100+
• `Optional` **onDisconnect**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) }) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
130101

131-
#### Parameters
102+
#### Type declaration
103+
104+
▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
105+
106+
##### Parameters
132107

133108
| Name | Type |
134109
| :------ | :------ |
135110
| `e` | `Object` |
136111
| `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) |
137112

138-
#### Returns
113+
##### Returns
139114

140115
[`MaybePromise`](../README.md#maybepromise)<`void`\>
141116

142117
___
143118

144119
### onError
145120

146-
▸ `Optional` **onError**(`error`, `context`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
121+
• `Optional` **onError**: (`error`: `any`, `context`: `any`) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
122+
123+
#### Type declaration
147124

148-
#### Parameters
125+
▸ (`error`, `context`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
126+
127+
##### Parameters
149128

150129
| Name | Type |
151130
| :------ | :------ |
152131
| `error` | `any` |
153132
| `context` | `any` |
154133

155-
#### Returns
134+
##### Returns
156135

157136
[`MaybePromise`](../README.md#maybepromise)<`void`\>
158137

159138
___
160139

161140
### onPing
162141

163-
▸ `Optional` **onPing**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
142+
• `Optional` **onPing**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `PingMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
143+
144+
#### Type declaration
145+
146+
▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
164147

165-
#### Parameters
148+
##### Parameters
166149

167150
| Name | Type |
168151
| :------ | :------ |
169152
| `e` | `Object` |
170153
| `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) |
171154
| `e.message` | `PingMessage` |
172155

173-
#### Returns
156+
##### Returns
174157

175158
[`MaybePromise`](../README.md#maybepromise)<`void`\>
176159

177160
___
178161

179162
### onPong
180163

181-
▸ `Optional` **onPong**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
164+
• `Optional` **onPong**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `PongMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
182165

183-
#### Parameters
166+
#### Type declaration
167+
168+
▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
169+
170+
##### Parameters
184171

185172
| Name | Type |
186173
| :------ | :------ |
187174
| `e` | `Object` |
188175
| `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) |
189176
| `e.message` | `PongMessage` |
190177

191-
#### Returns
178+
##### Returns
192179

193180
[`MaybePromise`](../README.md#maybepromise)<`void`\>
181+
182+
___
183+
184+
### pingpong
185+
186+
• `Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<{ `delay`: `number` ; `machine`: `string` ; `timeout`: `number` }\>
187+
188+
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.
189+
190+
___
191+
192+
### schema
193+
194+
• **schema**: `GraphQLSchema`
195+
196+
A GraphQL Schema with resolvers
197+
198+
You can use `makeExecutableSchema` from [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema), or `makeSchema` from [`nexus`](https://nexusjs.org/)
199+
200+
```ts
201+
import { makeExecutableSchema } from '@graphql-tools/schema
202+
// or
203+
import { makeSchema } from 'nexus'
204+
```
205+
206+
___
207+
208+
### tableNames
209+
210+
• `Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<{ `connections?`: `string` ; `subscriptions?`: `string` }\>
211+
212+
An optional object or a promise for an object with DDB table names.
213+
214+
Defaults to `{ connections: 'graphql_connections', subscriptions: 'graphql_subscriptions' }`

‎docs/interfaces/StateFunctionInput.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ ___
4040

4141
### state
4242

43-
• **state**: ``"PING"`` \| ``"REVIEW"`` \| ``"ABORT"``
43+
• **state**: ``"ABORT"`` \| ``"PING"`` \| ``"REVIEW"``

‎docs/interfaces/SubscribeOptions.md‎

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@
1414
### Properties
1515

1616
- [filter](SubscribeOptions.md#filter)
17-
18-
### Methods
19-
2017
- [onAfterSubscribe](SubscribeOptions.md#onaftersubscribe)
2118
- [onComplete](SubscribeOptions.md#oncomplete)
2219
- [onSubscribe](SubscribeOptions.md#onsubscribe)
@@ -29,59 +26,71 @@
2926

3027
An object or a function that returns an object that will be matched against the `payload` of a published event. If the payload's field equals the filter the subscription will receive the event. If the payload is missing the filter's field the subscription will receive the event.
3128

32-
## Methods
29+
___
3330

3431
### onAfterSubscribe
3532

36-
▸ `Optional` **onAfterSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
33+
• `Optional` **onAfterSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
34+
35+
#### Type declaration
36+
37+
▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
3738

3839
Gets resolver arguments to perform work after a subscription saved. This is useful for sending out initial events.
3940

40-
#### Parameters
41+
##### Parameters
4142

4243
| Name | Type |
4344
| :------ | :------ |
4445
| `...args` | `TSubscribeArgs` |
4546

46-
#### Returns
47+
##### Returns
4748

4849
[`MaybePromise`](../README.md#maybepromise)<`void`\>
4950

5051
___
5152

5253
### onComplete
5354

54-
▸ `Optional` **onComplete**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
55+
• `Optional` **onComplete**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\>
56+
57+
#### Type declaration
58+
59+
▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\>
5560

5661
Called at least once. Gets resolver arguments to perform work after a subscription has ended. This is useful for bookkeeping or logging. This callback will fire
5762

5863
If the client disconnects, sends a `complete` message, or the server sends a `complete` message via the pub/sub system. Because of the nature of aws lambda, it's possible for a client to send a "complete" message immediately disconnect and have those events execute on lambda out of order. Which why this function can be called up to twice.
5964

60-
#### Parameters
65+
##### Parameters
6166

6267
| Name | Type |
6368
| :------ | :------ |
6469
| `...args` | `TSubscribeArgs` |
6570

66-
#### Returns
71+
##### Returns
6772

6873
[`MaybePromise`](../README.md#maybepromise)<`void`\>
6974

7075
___
7176

7277
### onSubscribe
7378

74-
▸ `Optional` **onSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\>
79+
• `Optional` **onSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\>
80+
81+
#### Type declaration
82+
83+
▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\>
7584

7685
Gets resolver arguments to perform work before a subscription is allowed. This is useful for checking arguments or
7786
validating permissions. Return an array of GraphqlErrors if you don't want the subscription to subscribe.
7887

79-
#### Parameters
88+
##### Parameters
8089

8190
| Name | Type |
8291
| :------ | :------ |
8392
| `...args` | `TSubscribeArgs` |
8493

85-
#### Returns
94+
##### Returns
8695

8796
[`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\>

0 commit comments

Comments
 (0)