@creator.co/wapi - v1.8.1
    Preparing search index...

    Abstract class representing a database transaction. Warning: These need to be arrow functions! DatabaseTransaction

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructor for a class that interacts with a database using a writer and reader.

      Parameters

      • writer: any

        The object responsible for writing to the database.

      • database: Database<any>

        The database to interact with.

      • Optionalreader: any

        The object responsible for reading from the database (optional).

      Returns DatabaseTransaction

      None

    Properties

    _isOpen: boolean

    A boolean flag indicating whether a certain feature is open or closed.

    arguments: any
    caller: Function
    database: Database<any>

    A protected property representing a database of type Database. This property is accessible within the class and its subclasses.

    doBegin: () => Promise<any>

    Abstract method that defines the beginning of an asynchronous operation.

    Type declaration

      • (): Promise<any>
      • Returns Promise<any>

        A Promise that resolves when the operation begins.

    doCommit: () => Promise<any>

    Abstract method that should be implemented by subclasses to perform a commit operation.

    Type declaration

      • (): Promise<any>
      • Returns Promise<any>

        A Promise that resolves when the commit operation is completed.

    doRollback: () => Promise<any>

    An abstract method that defines the rollback functionality. This method should be implemented by subclasses to perform the actual rollback operation.

    Type declaration

      • (): Promise<any>
      • Returns Promise<any>

        A Promise that resolves when the rollback operation is completed.

    length: number
    name: string

    Returns the name of the function. Function names are read-only and can not be changed.

    prototype: any
    reader: any

    A property representing a reader object.

    transaction: any

    A protected property representing a transaction.

    writer: any

    A property representing a writer object.

    Methods

    • Determines whether the given value inherits from this function if this function was used as a constructor function.

      A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

      Parameters

      • value: any

      Returns boolean

    • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

      Parameters

      • this: Function
      • thisArg: any

        The object to be used as the this object.

      • OptionalargArray: any

        A set of arguments to be passed to the function.

      Returns any

    • Begins a transaction asynchronously.

      Returns Promise<void>

      A Promise that resolves when the transaction has begun.

      If the transaction is already open.

    • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

      Parameters

      • this: Function
      • thisArg: any

        An object to which the this keyword can refer inside the new function.

      • ...argArray: any[]

        A list of arguments to be passed to the new function.

      Returns any

    • Calls a method of an object, substituting another object for the current object.

      Parameters

      • this: Function
      • thisArg: any

        The object to be used as the current object.

      • ...argArray: any[]

        A list of arguments to be passed to the method.

      Returns any

    • Closes the failure by performing a rollback if the failure is currently open.

      Returns Promise<void>

      A promise that resolves once the rollback is completed.

    • Closes the success modal, committing or rolling back changes based on the autoCommit setting. If the modal is open and autoCommit is enabled, it will commit the changes. If autoCommit is disabled, it will rollback the changes.

      Returns Promise<void>

      A promise that resolves once the commit or rollback operation is completed.

    • Asynchronously commits the transaction. If the transaction is already closed, an error is thrown.

      Returns Promise<void>

      Promise

      Error if the transaction is already closed

    • Rollback the transaction by reverting any changes made within the transaction. If the transaction is already closed, an error is thrown.

      Returns Promise<void>

      Promise

      Error if the transaction is already closed.

    • Returns a string representation of a function.

      Returns string

    • Creates a proxy instance for the given subclass of DatabaseTransaction. The proxy handles method binding and transaction execution based on the subclass state.

      Type Parameters

      Parameters

      • subclass: T

        The subclass of DatabaseTransaction to proxy.

      Returns T

      A proxied instance of the subclass with method binding and transaction execution logic.