Class ApiGatewayWsAdapterError

Thrown when the API Gateway WebSocket adapter is misused or a required AWS SDK is missing.

Hierarchy

IntegrationError
- ApiGatewayWsAdapterError

Index

Constructors

Properties

cause? code? metadata?

Methods

toString create

Constructors

constructor

new ApiGatewayWsAdapterError(
message: string,
options?: ErrorOptions,
): ApiGatewayWsAdapterError
Parameters
- message: string
- Optionaloptions: ErrorOptions
Returns ApiGatewayWsAdapterError

Overrides IntegrationError.constructor

Properties

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`code

code?: string

`Optional` `Readonly`metadata

metadata?: unknown

Methods

toString

toString(multiline?: boolean): string
Converts the error to a formatted string representation.
Parameters
- Optionalmultiline: boolean
  Determine if output value must be multiline or not.
Returns string
A formatted error string.

Inherited from IntegrationError.toString

`Static`create

create<T extends RuntimeError = RuntimeError>(
message: string,
options?: ErrorOptions,
): T
Create a RuntimeError.
Type Parameters
- T extends RuntimeError = RuntimeError
Parameters
- message: string
- Optionaloptions: ErrorOptions
  The options to create a RuntimeError.
Returns T
A new RuntimeError instance.

Inherited from IntegrationError.create