Class ServerlessDiscordLambdaRouter

Serverless Discord Router for AWS Lambda

This class is responsible for handling the AWS Lambda event and converting it into a DiscordInteraction. This is then passed to the ServerlessDiscordRouter to handle the interaction.

This class also handles async application commands. These are commands that are not expected to return a response immediately. The async handler should be run as a seperate Lambda function. This function will be called with the interaction data as the event.

Hierarchy

ServerlessDiscordRouter
- ServerlessDiscordLambdaRouter

Index

Constructors

constructor

new ServerlessDiscordLambdaRouter(__namedParameters: {
    apiClient?: DiscordApiClient;
    applicationId: string;
    authHandler?: AuthHandler;
    commands: Command[];
    logHandler: Logger<LoggerOptions>;
    queueUrl?: string;
    sqsClient?: SQSClient;
}): ServerlessDiscordLambdaRouter
Parameters
- __namedParameters: {
      apiClient?: DiscordApiClient;
      applicationId: string;
      authHandler?: AuthHandler;
      commands: Command[];
      logHandler: Logger<LoggerOptions>;
      queueUrl?: string;
      sqsClient?: SQSClient;
  }
  - Optional apiClient?: DiscordApiClient
  - applicationId: string
  - Optional authHandler?: AuthHandler
  - commands: Command[]
  - logHandler: Logger<LoggerOptions>
  - Optional queueUrl?: string
  - Optional sqsClient?: SQSClient
Returns ServerlessDiscordLambdaRouter
Overrides ServerlessDiscordRouter.constructor
- Defined in lambda/router.ts:85

Properties

`Protected` `Optional` apiClient

apiClient?: DiscordApiClient

`Protected` applicationId

applicationId: string

`Protected` `Optional` authHandler

authHandler?: AuthHandler

`Protected` commands

commands: Command[]

`Protected` logHandler

logHandler: Logger<LoggerOptions>

`Protected` `Optional` queueUrl

queueUrl?: string

`Protected` `Optional` sqsClient

sqsClient?: SQSClient

Methods

`Private` addInteractionToQueue

addInteractionToQueue(interaction: DiscordInteractionApplicationCommand): Promise<void>
Adds an interaction to an SQS queue to be processed by an async lambda function
Parameters
- interaction: DiscordInteractionApplicationCommand
Returns Promise<void>
- Defined in lambda/router.ts:155

`Protected` getCommand

getCommand(name: string): Command
Parameters
- name: string
Returns Command
Inherited from ServerlessDiscordRouter.getCommand
- Defined in core/router.ts:133

handle

handle(__namedParameters: {
interaction: unknown;
requestHeaders: unknown;
}): Promise<DiscordInteractionResponse>
Parameters
- __namedParameters: {
  interaction: unknown;
  requestHeaders: unknown;
  }
  - interaction: unknown
  - requestHeaders: unknown
Returns Promise<DiscordInteractionResponse>
Inherited from ServerlessDiscordRouter.handle
- Defined in core/router.ts:76

handleApplicationCommand

handleApplicationCommand(interaction: DiscordInteractionApplicationCommand): Promise<DiscordInteractionResponse>
Handler for AWS Lambda that handles Discord bot interactions
Parameters
- interaction: DiscordInteractionApplicationCommand
Returns Promise<DiscordInteractionResponse>
Overrides ServerlessDiscordRouter.handleApplicationCommand
- Defined in lambda/router.ts:174

handleInteraction

handleInteraction(interaction: DiscordInteraction): Promise<DiscordInteractionResponse>
Handle an incoming Discord interaction.

Returns
Parameters
- interaction: DiscordInteraction
  
  An incoming Discord interaction from the web
Returns Promise<DiscordInteractionResponse>
Inherited from ServerlessDiscordRouter.handleInteraction
- Defined in core/router.ts:109

handleLambda

handleLambda(event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult>
Handler for AWS Lambda behind API Gateway that handles Discord bot interactions

Returns
APIGatewayProxyResult
Parameters
- event: APIGatewayProxyEvent
  
  APIGatewayEvent from AWS Lambda
Returns Promise<APIGatewayProxyResult>
- Defined in lambda/router.ts:114

handleLambdaAsyncApplicationCommand

handleLambdaAsyncApplicationCommand(event: DiscordInteractionApplicationCommand): Promise<void>
Handler for AWS Lambda that handles async application commands. This should be invoked asynchronously by handleDiscordWebhook as a seperate Lambda function.
Parameters
- event: DiscordInteractionApplicationCommand
  
  Interaction from handleDiscordWebhook
Returns Promise<void>
- Defined in lambda/router.ts:189

handleSqsEvent

handleSqsEvent(event: SQSEvent): Promise<void>
Handles an SQS event that contains Discord interactions
Parameters
- event: SQSEvent
Returns Promise<void>
- Defined in lambda/router.ts:208

Class ServerlessDiscordLambdaRouter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { apiClient?: DiscordApiClient; applicationId: string; authHandler?: AuthHandler; commands: Command[]; logHandler: Logger<LoggerOptions>; queueUrl?: string; sqsClient?: SQSClient; }

Optional apiClient?: DiscordApiClient

applicationId: string

Optional authHandler?: AuthHandler

commands: Command[]

logHandler: Logger<LoggerOptions>

Optional queueUrl?: string

Optional sqsClient?: SQSClient

Returns ServerlessDiscordLambdaRouter

Properties

Protected Optional apiClient

Protected applicationId

Protected Optional authHandler

Protected commands

Protected logHandler

Protected Optional queueUrl

Protected Optional sqsClient

Methods

Private addInteractionToQueue

Parameters

interaction: DiscordInteractionApplicationCommand

Returns Promise<void>

Protected getCommand

Parameters

name: string

Returns Command

handle

Parameters

__namedParameters: { interaction: unknown; requestHeaders: unknown; }

interaction: unknown

requestHeaders: unknown

Returns Promise<DiscordInteractionResponse>

handleApplicationCommand

Parameters

interaction: DiscordInteractionApplicationCommand

Returns Promise<DiscordInteractionResponse>

handleInteraction

Returns

Parameters

interaction: DiscordInteraction

Returns Promise<DiscordInteractionResponse>

handleLambda

Returns

Parameters

event: APIGatewayProxyEvent

Returns Promise<APIGatewayProxyResult>

handleLambdaAsyncApplicationCommand

Parameters

event: DiscordInteractionApplicationCommand

Returns Promise<void>

handleSqsEvent

Parameters

event: SQSEvent

Returns Promise<void>

Settings

Member Visibility

Theme

__namedParameters: {
apiClient?: DiscordApiClient;
applicationId: string;
authHandler?: AuthHandler;
commands: Command[];
logHandler: Logger<LoggerOptions>;
queueUrl?: string;
sqsClient?: SQSClient;
}

`Optional` apiClient?: DiscordApiClient

`Optional` authHandler?: AuthHandler

`Optional` queueUrl?: string

`Optional` sqsClient?: SQSClient

`Protected` `Optional` apiClient

`Protected` applicationId

`Protected` `Optional` authHandler

`Protected` commands

`Protected` logHandler

`Protected` `Optional` queueUrl

`Protected` `Optional` sqsClient

`Private` addInteractionToQueue

`Protected` getCommand

__namedParameters: {
interaction: unknown;
requestHeaders: unknown;
}