Skip to content

Latest commit

 

History

History
92 lines (54 loc) · 2.03 KB

File metadata and controls

92 lines (54 loc) · 2.03 KB

graphql-lambda-subscriptions / SubscriptionServer

Interface: SubscriptionServer

Table of contents

Methods

Methods

complete

complete(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.

Parameters

Name Type
event Object
event.payload? Record<string, any>
event.topic string

Returns

Promise<void>


publish

publish(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.

Parameters

Name Type
event Object
event.payload Record<string, any>
event.topic string

Returns

Promise<void>


stepFunctionsHandler

stepFunctionsHandler(input): Promise<StateFunctionInput>

The handler for your step functions powered ping/pong support

Parameters

Name Type
input StateFunctionInput

Returns

Promise<StateFunctionInput>


webSocketHandler

webSocketHandler(event): Promise<WebSocketResponse>

The handler for your websocket functions

Parameters

Name Type
event APIGatewayWebSocketEvent

Returns

Promise<WebSocketResponse>