API.md

API Reference

Table of Contents

• Classes
  • WebSocket
  • platform.WebSocket_tfaws
  • platform.WebSocket_sim
  • platform.WebSocket_awscdk
• Interfaces
  • platform.aws.IAwsWebSocket
  • commons.IWebSocket
• Structs
  • platform.aws.WebSocketAwsRequest
  • platform.aws.WebSocketAwsRequestContext
  • platform.aws.WebSocketAwsResponse
  • commons.WebSocketProps

WebSocket (preflight class)

No description

Constructor

new(props: WebSocketProps): WebSocket

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

platform.WebSocket_tfaws (preflight class)

No description

Constructor

new(props: WebSocketProps): WebSocket_tfaws

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
addRoute(handler: Function, routeKey: str): void	No description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

platform.WebSocket_sim (preflight class)

No description

Constructor

new(props: WebSocketProps): WebSocket_sim

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

platform.WebSocket_awscdk (preflight class)

No description

Constructor

new(props: WebSocketProps): WebSocket_awscdk

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
addRoute(handler: Function, routeKey: str): void	No description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

platform.aws.IAwsWebSocket (interface)

No description

Properties

No properties

Methods

Signature	Description
addRoute(handler: Function, routeKey: str): void	No description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

commons.IWebSocket (interface)

No description

Properties

No properties

Methods

Signature	Description
onConnect(handler: inflight (str): void): void	No description
onDisconnect(handler: inflight (str): void): void	No description
onMessage(handler: inflight (str, str): void): void	No description
inflight sendMessage(connectionId: str, message: str): void	No description

platform.aws.WebSocketAwsRequest (struct)

No description

Properties

Name	Type	Description
body	str	No description
requestContext	WebSocketAwsRequestContext	No description

platform.aws.WebSocketAwsRequestContext (struct)

No description

Properties

Name	Type	Description
connectionId	str	No description
routeKey	str	No description

platform.aws.WebSocketAwsResponse (struct)

No description

Properties

Name	Type	Description
body	str?	No description
statusCode	num	No description

commons.WebSocketProps (struct)

No description

Properties

Name	Type	Description
name	str	No description
stageName	str?	No description