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

    Represents a transaction in a Postgres database.

    Hierarchy (View Summary)

    Index

    Properties

    _isOpen: boolean

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

    arguments: any
    caller: Function

    A protected property representing a database of type Database. This property is used to interact with a Postgres database using transactions.

    length: number
    name: string

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

    prototype: any
    reader: Pool

    A readonly property representing a pool reader.

    transaction: PoolClient

    Represents a database transaction using a PoolClient.

    writer: Pool

    A Pool object used for writing operations.

    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

    • 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 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.

    • Initiates a transaction by connecting to the writer and executing a 'BEGIN' query.

      Returns Promise<QueryResult<any>>

      A promise that resolves when the transaction is successfully initiated.

    • Executes a COMMIT query to commit the current transaction.

      Returns Promise<QueryResult<any>>

      A Promise that resolves when the COMMIT query is successfully executed.

    • Rolls back the current transaction by executing a 'ROLLBACK' query.

      Returns Promise<QueryResult<any>>

      A Promise that resolves when the rollback is successful.

    • 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