ts-lambda-api - v2.5.2
    Preparing search index...

    Class ApiLambdaApp

    Impementation of the ApiApp class that handles native AWS Lambda requests and can be used to provide a Lambda function handler.

    The run method is the function handler entrypoint.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiServer appConfig appContainer autoInjectionEnabled controllersPath? initialised logFactory logger

    Accessors

    middlewareRegistry

    Methods

    configureApi configureApp initialiseControllers run

    Constructors

    • Create a new lambda app.

      Parameters

      • OptionalcontrollersPath: string[]

        (Optional) Paths to the directories that contain controller js files. Required if the default Container is used, or the provided Container instance has its autobind flag enabled. Ignored if the provided Container instance has its autobind flag enabled.

      • OptionalappConfig: AppConfig

        (Optional) Application config to pass to lambda-api.

      • OptionalautoInjectionEnabled: boolean

        (Optional) Enable auto injection in IOC container, defaults to new true.

      • OptionalappContainer: Container

        (Optional) InversifyJS IOC Container instance which can build controllers and error interceptors, defaults to new Container using autobind flag set to true if autoInjectionEnabled is true.

      Returns ApiLambdaApp

    Properties

    apiServer: Server
    appConfig: AppConfig = ...

    (Optional) Application config to pass to lambda-api, defaults to new AppConfig.

    appContainer: Container = ...

    (Optional) InversifyJS IOC Container instance which can build controllers and error interceptors, defaults to new Container using autobind flag set to true if autoInjectionEnabled is true. If you pass your own instance autoInjectionEnabled must reflect the autobind flag passed to the Container.

    autoInjectionEnabled: boolean = true

    (Optional) Is auto injection enabled in the IOC container? Defaults to true.

    controllersPath?: string[]

    (Optional) Paths to the directories that contain controller js files that declare controllers. Required if the default Container is used, or the autoInjectionEnabled is set to true. Ignored if the autoInjectionEnabled is set to false.

    initialised: boolean
    logFactory: LogFactory
    logger: ILogger

    Accessors

    Methods

    • Configure the API instance from the lambda-api package.

      Parameters

      • configureBlock: (this: void, api: API) => void

        Function that takes an API instance as a parameter.

      Returns void

    • Configure the InversifyJS IOC Container instance.

      Parameters

      • configureBlock: (this: void, container: Container) => void

        Function that takes a Container instance as a parameter.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods