Class Server

Server that discovers routes using decorators on controller classes and methods. Processing of requests is preformed by the lambda-api package.

Index

Constructors

Accessors

middlewareRegistry

Methods

configure discoverAndBuildRoutes processEvent

Constructors

constructor

new Server(
    appContainer: Container,
    autoInjectionEnabled: boolean,
    appConfig: AppConfig,
): Server
Create a new server.
Parameters
- appContainer: Container
  Application container to use to build containers.
- autoInjectionEnabled: boolean
  Is autobind flag enabled on IOC container.
- appConfig: AppConfig
  Application config to pass to lambda-api.
Returns Server
- Defined in src/api/Server.ts:40

Accessors

middlewareRegistry

get middlewareRegistry(): MiddlewareRegistry
Returns MiddlewareRegistry
- Defined in src/api/Server.ts:29

Methods

configure

configure(handler: (this: void, api: API) => void): void
Configure the API instance from the lambda-api package.
Parameters
- handler: (this: void, api: API) => void
  Function that takes an API instance as a parameter.
Returns void
- Defined in src/api/Server.ts:61

discoverAndBuildRoutes

discoverAndBuildRoutes(controllersPath?: string[]): Promise<void>
Scans the specified path for javascript files and loads these into the current runtime. Importing the files will invoke the decorators declared within them. Note: this scans only the top level files.

API decorators register controllers, endpoints, configuration and middleware. A series of endpoints are built using the decorator components and registered with the lambda-api package routing engine.

Controllers and error interceptors registered by decorators are built using an IOC container, which allows dependency injection.

OpenAPI endpoints will be registered here, if they are enabled in the app config by setting the openApi.enabled flag to true.

This method must be called before invoking the processEvent method.
Parameters
- OptionalcontrollersPath: string[]
  (Optional) Paths to the directories that contain controller js files. Dynamic loading of injectable controllers is disabled if undefined or the app Container instance has its autobind flag disabled.
Returns Promise<void>
- Defined in src/api/Server.ts:88

processEvent

processEvent(request: ApiRequest, context: any): Promise<ApiResponse>
Takes an API request passed in by AWS Lambda and processes it using the lambda-api package.
Parameters
- request: ApiRequest
  API Gateway or ALB request.
- context: any
  Request context.
Returns Promise<ApiResponse>
The response.
- Defined in src/api/Server.ts:153