graphql-lambda-subscriptions / SubscriptionServer
• complete: (event
: { payload?
: Record
<string
, any
> ; topic
: string
}) => Promise
<void
>
▸ (event
): Promise
<void
>
Send a complete message and end all relevant subscriptions. This might take some time depending on how many subscriptions there are.
The payload if present will be used to match against any filters the subscriptions might have.
Name | Type |
---|---|
event |
Object |
event.payload? |
Record <string , any > |
event.topic |
string |
Promise
<void
>
• publish: (event
: { payload
: Record
<string
, any
> ; topic
: string
}) => Promise
<void
>
▸ (event
): Promise
<void
>
Publish an event to all relevant subscriptions. This might take some time depending on how many subscriptions there are.
The payload if present will be used to match against any filters the subscriptions might have.
Name | Type |
---|---|
event |
Object |
event.payload |
Record <string , any > |
event.topic |
string |
Promise
<void
>
• stepFunctionsHandler: (input
: StateFunctionInput
) => Promise
<StateFunctionInput
>
▸ (input
): Promise
<StateFunctionInput
>
The handler for your step functions powered ping/pong support
Name | Type |
---|---|
input |
StateFunctionInput |
Promise
<StateFunctionInput
>
• webSocketHandler: (event
: APIGatewayWebSocketEvent
) => Promise
<WebSocketResponse
>
▸ (event
): Promise
<WebSocketResponse
>
The handler for your websocket functions
Name | Type |
---|---|
event |
APIGatewayWebSocketEvent |
Promise
<WebSocketResponse
>