@beholdio/ts-lambda-api - v2.4.8
    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

    • 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 autoBindInjectable flag set to true. Ignored if the provided Container instance has its autoBindInjectable flag set to false.

      • OptionalappConfig: AppConfig

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

      • OptionalappContainer: Container

        (Optional) InversifyJS IOC Container instance which can build controllers and error interceptors.

      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 with autoBindInjectable flag set 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 provided Container instance has its autoBindInjectable flag set to true. Ignored if the provided Container instance has its autoBindInjectable flag 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

      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