Class GenericController`Abstract`

An abstract class to inherit to manage some resources with an AWS Lambda function.

Hierarchy (View Summary)

GenericController
- ResourceController
- StreamController

Index

Constructors

Properties

Methods

done getLambdaLogLevel handleControllerError handleRequest setLambdaLogLevel silentLambdaLogs

Constructors

constructor

new GenericController(event: any): GenericController
Initialize a new GenericController helper object.
Parameters
- event: any
  the event that invoked the AWS lambda function
Returns GenericController
- Defined in src/genericController.ts:17

Properties

`Protected`event

event: any

`Protected`logger

logger: LambdaLogger = ...

Methods

`Protected`done

done(error?: any, res?: any): any
Default ending function for the Lambda.
Parameters
- error: any = null
- Optionalres: any
Returns any
- Defined in src/genericController.ts:32

getLambdaLogLevel

getLambdaLogLevel(): "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
Get the current log level for the current Lambda function's logger. Note: "FATAL" means that no log will be printed.

Returns "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
- Defined in src/genericController.ts:63

`Protected`handleControllerError

handleControllerError(
    err: any,
    interceptedInContext: string,
    replaceWithMessage: string,
): UnhandledError | HandledError
Remap an error to manage the logging and make sure no unhandled error is returned to the requester.
Parameters
- err: any
- interceptedInContext: string
- replaceWithMessage: string
Returns UnhandledError | HandledError
- Defined in src/genericController.ts:46

handleRequest

handleRequest(): Promise<any>
The main function (to override), that handles the request and must terminate invoking the method done.

Returns Promise<any>
- Defined in src/genericController.ts:24

setLambdaLogLevel

setLambdaLogLevel(
logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL",
): void
Set the log level for the current Lambda function's logger.
Parameters
- logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
Returns void
- Defined in src/genericController.ts:69

silentLambdaLogs

silentLambdaLogs(): void
Raise the log level of the current Lambda function's logger to "FATAL", hence avoiding printing any log.

Returns void
- Defined in src/genericController.ts:75