Class default<InputType, ResponseInnerType, MiscRespType, PathParamsType, QueryParamsType>

Represents a transaction object that handles the execution of a request and manages the response.

Type Parameters

InputType = never
The type of the input data for the transaction.
ResponseInnerType = null
The type of the inner response data for the transaction.
MiscRespType = never
The type of miscellaneous response data for the transaction.
PathParamsType = StringMap
QueryParamsType = StringMap

Index

Constructors

Properties

logger publisher request responseProxy

Methods

execute getDatabase getDbTransaction getRemainingTimeInMillis

Constructors

constructor

new default<
    InputType = never,
    ResponseInnerType = null,
    MiscRespType = never,
    PathParamsType = StringMap,
    QueryParamsType = StringMap,
>(
    event: APIGatewayProxyEvent | SQSEvent | DynamoDBStreamEvent,
    context: Context,
    config?: TransactionConfig,
): default<
    InputType,
    ResponseInnerType,
    MiscRespType,
    PathParamsType,
    QueryParamsType,
>
Constructs a new instance of the Transaction class.
Type Parameters
- InputType = never
- ResponseInnerType = null
- MiscRespType = never
- PathParamsType = StringMap
- QueryParamsType = StringMap
Parameters
- event: APIGatewayProxyEvent | SQSEvent | DynamoDBStreamEvent
  The event object passed to the Lambda function.
- context: Context
  The context object passed to the Lambda function.
- Optionalconfig: TransactionConfig
  Optional configuration object for the transaction.
Returns default<
    InputType,
    ResponseInnerType,
    MiscRespType,
    PathParamsType,
    QueryParamsType,
>
None
- Defined in src/BaseEvent/Transaction.ts:124

Properties

`Readonly`logger

logger: default

A logger object used for logging messages, errors, and other information.

`Readonly`publisher

publisher: default

The publisher of the content.

`Readonly`request

request: default<InputType, PathParamsType, QueryParamsType>

The request object for making a request of type InputType.

responseProxy

responseProxy: null | ((response: default<ResponseInnerType>) => Promise<void>)

A function that acts as a response proxy for a given response object.

Param: response

The response object to proxy.

Returns

A promise that resolves to void.

Methods

execute

execute(
    executionFunc: TransactionExecution<
        default<
            InputType,
            ResponseInnerType,
            MiscRespType,
            PathParamsType,
            QueryParamsType,
        >,
        ResponseInnerType,
        MiscRespType,
    >,
): Promise<
    null
    | MiscRespType
    | default<ResponseErrorType | ResponseInnerType>,
>
Executes a transaction using the provided execution function and returns a promise that resolves to the response or miscellaneous response.
Parameters
- executionFunc: TransactionExecution<
      default<
          InputType,
          ResponseInnerType,
          MiscRespType,
          PathParamsType,
          QueryParamsType,
      >,
      ResponseInnerType,
      MiscRespType,
  >
  The execution function to be executed.
Returns Promise<null | MiscRespType | default<ResponseErrorType | ResponseInnerType>>
- A promise that resolves to the response or miscellaneous response.
- Defined in src/BaseEvent/Transaction.ts:158

getDatabase

getDatabase<S extends "knex" | "pg" | "kysely" | "dynamo", DBSchema>(
config: DbConfig<S>,
): DatabaseImplType<S, DBSchema>
Retrieves a database instance based on the provided configuration.
Type Parameters
- S extends "knex" | "pg" | "kysely" | "dynamo"
- DBSchema
Parameters
- config: DbConfig<S>
  The configuration object specifying the type of database.
Returns DatabaseImplType<S, DBSchema>
A database instance based on the provided configuration.
- Defined in src/BaseEvent/Transaction.ts:246

getDbTransaction

getDbTransaction<S extends "knex" | "pg" | "kysely" | "dynamo", DBSchema>(
config: DbConfig<S>,
): Promise<DatabaseTransactionType<S, DBSchema>>
Retrieves a database transaction based on the provided database configuration.
Type Parameters
- S extends "knex" | "pg" | "kysely" | "dynamo"
- DBSchema
Parameters
- config: DbConfig<S>
  The configuration object for the database.
Returns Promise<DatabaseTransactionType<S, DBSchema>>
A promise that resolves to the database transaction.
- Defined in src/BaseEvent/Transaction.ts:232

getRemainingTimeInMillis

getRemainingTimeInMillis(): number
Get the remaining time in milliseconds for the current execution context.

Returns number
The remaining time in milliseconds, or -1 if the time is not available.
- Defined in src/BaseEvent/Transaction.ts:256