@nodeboot/starter-persistence/dist/hook/transaction.hooks.d.ts

Nodeboot starter package for persistence. Supports data access layer auto-configuration providing features like database initialization, consistency check, entity mapping, repository pattern, transactions, paging, migrations, persistence listeners, persis

import { WrapInTransactionOptions } from "typeorm-transactional";
/**
 * Registers a callback to be executed when the current transaction is successfully committed.
 *
 * @param cb - The callback function to execute on transaction commit.
 *
 * @example
 * ```ts
 * runOnTransactionCommit(() => {
 *   console.log("Transaction committed successfully");
 * });
 * ```
 *
 * @author
 * Manuel Santos <https://github.com/manusant>
 */
export declare const runOnTransactionCommit: (cb: () => void) => void;
/**
 * Registers a callback to be executed when the current transaction is rolled back.
 *
 * @param cb - The callback function that receives the error that caused the rollback.
 *
 * @example
 * ```ts
 * runOnTransactionRollback((err) => {
 *   console.error("Transaction rolled back", err);
 * });
 * ```
 *
 * @author
 * Manuel Santos <https://github.com/manusant>
 */
export declare const runOnTransactionRollback: (cb: (e: Error) => void) => void;
/**
 * Registers a callback to be executed when the current transaction is either committed or rolled back.
 *
 * @param cb - The callback function that receives an optional error (if the transaction was rolled back).
 *
 * @example
 * ```ts
 * runOnTransactionComplete((err) => {
 *   if (err) {
 *     console.error("Transaction failed", err);
 *   } else {
 *     console.log("Transaction completed successfully");
 *   }
 * });
 * ```
 *
 * @author
 * Manuel Santos <https://github.com/manusant>
 */
export declare const runOnTransactionComplete: (cb: (e: Error | undefined) => void) => void;
/**
 * Executes a given function within a transaction.
 *
 * @template F - The function type to be executed inside the transaction.
 * @param fn - The function to be executed within the transaction.
 * @param options - Optional transaction options (e.g., isolation level, propagation).
 * @returns The result of the function execution within the transaction.
 *
 * @example
 * ```ts
 * const result = await runInTransaction(async () => {
 *   await userRepo.save(user);
 *   await auditRepo.log("User created");
 *   return "done";
 * });
 * ```
 *
 * @author
 * Manuel Santos <https://github.com/manusant>
 */
export declare const runInTransaction: <F extends (this: unknown) => ReturnType<F>>(fn: F, options?: WrapInTransactionOptions) => ReturnType<F>;
//# sourceMappingURL=transaction.hooks.d.ts.map