nestjs-transaction/dist/interfaces/index.d.ts

A library that extracts and provides only some of the functions of the 'typeorm-transactional' npm module that are needed to operate in the Nestjs + TypeORM environment

import { DataSourceName, StoreOption } from '../common';
import { IsolationLevelType, PropagationType } from '../enums';
export interface TransactionOptions {
    /**
     * Database Connection Name
     */
    connectionName?: string;
    /**
     * Set transaction isolation level options
     * @default 'READ COMMITTED' Read committed history only
     */
    isolationLevel?: IsolationLevelType;
    /**
     * Transaction propagation level setting options
     * @default 'REQUIRED' Internal transactions participate in running external transactions (default properties)
     */
    propagation?: PropagationType;
}
export interface TransactionModuleOption extends Partial<Pick<StoreOption, 'maxEventListeners'>> {
    /**
     * Locate the entered data source name and register it as a transaction data source.
     * If that value is not entered, it automatically registers all data sources.
     *
     * @NOTE [Nestjs Docs](https://docs.nestjs.com/techniques/database),
     * If you are using TypeOrmModule.forRootAsync, you have to also set the "data source name" outside useFactory
     * and add the name you set to the property
     */
    dataSourceNames?: DataSourceName[];
}
/**
 * Transaction lifecycle Hook interface
 *
 * @example ```ts
 * export class TestTransaction implements Transaction {
 * constructor(@Inject('TestService') private readonly testService: TestService) {}
 *
 *  async onCommit(...param: unknown[]) {
 *      await this.testService.test();
 *  }
 *}
 * ```
 */
export interface TransactionEventListener {
    /**
     * After the transaction is committed, the onCommit method is called.
     * @param param Origin method parameters
     */
    onCommit(...param: unknown[]): unknown;
    /**
     * After the transaction is rolled back, the onRollBack method is called.
     * @param e Error object that caused the rollback
     * @param param Origin method parameters
     */
    onRollBack(e: Error, ...param: unknown[]): unknown;
}