Method batch

lib/TransactionKit.ts:1012–1039

* Selects a batch by name for subsequent batch operations. * * This method sets the current batch context to the specified batch name, allowing batch-level operations such as remove, getState, and reset. Throws an error if the batch name is invalid or does not exist. * * @param params -

({ batchName }: BatchParams)

   * - This method is chainable and is typically used to manage or inspect a batch of transactions.
   */
  batch({ batchName }: BatchParams): IBatch {
    if (typeof batchName !== 'string' || batchName.trim() === '') {
      this.throwError(
        'batch(): batchName is required and must be a non-empty string.'
      );
    }
    if (!this.batches[batchName]) {
      this.throwError(`batch(): Batch '${batchName}' does not exist.`);
    }
    this.selectedBatchName = batchName;
    this.workingTransaction = undefined;
    this.selectedTransactionName = undefined;
    log('batch(): Selected batch', batchName, this.debugMode);
    // Only allow remove, getState, and reset after selecting a batch
    // eslint-disable-next-line @typescript-eslint/no-this-alias
    const self = this;
    return {
      remove() {
        return self.remove();
      },
      getState() {
        return self.getState();
      },
      reset() {
        return self.reset();
      },
    };
  }

  /**
   * Adds the current transaction to a specified batch, creating the batch if it does not exist.