Bun

interface

SQLQuery

interface SQLQuery<T = any>

Represents a SQL query that can be executed, with additional control methods Extends Promise to allow for async/await usage

  • readonly [Symbol.toStringTag]: string
  • active: boolean

    Indicates if the query is currently executing

  • cancelled: boolean

    Indicates if the query has been cancelled

  • Cancels the executing query

  • catch<TResult = never>(
    onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>
    ): Promise<T | TResult>;

    Attaches a callback for only the rejection of the Promise.

    @param onrejected

    The callback to execute when the Promise is rejected.

    @returns

    A Promise for the completion of the callback.

  • Executes the query

  • onfinally?: null | () => void
    ): Promise<T>;

    Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    @param onfinally

    The callback to execute when the Promise is settled (fulfilled or rejected).

    @returns

    A Promise for the completion of the callback.

  • raw(): SQLQuery<T>;

    Returns the raw query result

  • Execute as a simple query, no parameters are allowed but can execute multiple commands separated by semicolons

  • then<TResult1 = T, TResult2 = never>(
    onfulfilled?: null | (value: T) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>
    ): Promise<TResult1 | TResult2>;

    Attaches callbacks for the resolution and/or rejection of the Promise.

    @param onfulfilled

    The callback to execute when the Promise is resolved.

    @param onrejected

    The callback to execute when the Promise is rejected.

    @returns

    A Promise for the completion of which ever callback is executed.

  • Returns only the values from the query result