Documentation
API Reference
aws
interfaces

Interface: ApiGatewayHandler

lambda.ApiGatewayHandler

Interface for the actual API gateway Lambda function. Has some extra functionality besides the default call handler for example schema validation for testing purposes.

Hierarchy

  • Handler<APIGatewayProxyEvent, APIGatewayProxyResult>

    ↳ ApiGatewayHandler

Callable

ApiGatewayHandler

▸ ApiGatewayHandler(event, context, callback): void | Promise<APIGatewayProxyResult>

Parameters

Name Type
event APIGatewayProxyEvent
context Context
callback Callback<APIGatewayProxyResult>

Returns

void | Promise<APIGatewayProxyResult>

Properties

validateSchema

• Optional validateSchema: ValidateFunction<unknown>

Validate a data object against the handler schema. If no schema is provided to the handler this will be undefined.

Param

Object to validate