bullmq - v6.3.4
    Preparing search index...

    Interface PgPoolClient

    Structural subset of a pg.PoolClient (a single checked-out connection). Used for the dedicated migration session.

    interface PgPoolClient {
        connection?: {
            stream?: {
                setKeepAlive?(enable: boolean, initialDelay?: number): unknown;
            };
        };
        on(event: "notification", listener: (msg: PgNotification) => void): this;
        on(event: "error", listener: (err: Error) => void): this;
        on(event: "end", listener: () => void): this;
        query<R = any>(
            text: string,
            params?: readonly unknown[],
        ): Promise<PgQueryResult<R>>;
        release(destroy?: boolean): void;
        removeAllListeners(event?: string): this;
        removeListener(
            event: "notification",
            listener: (msg: PgNotification) => void,
        ): this;
    }

    Hierarchy

    • PgListenClient
      • PgPoolClient
    Index
    connection?
    on query release removeAllListeners removeListener
    connection?: {
        stream?: {
            setKeepAlive?(enable: boolean, initialDelay?: number): unknown;
        };
    }

    node-postgres' internal connection wrapper. Only used to reach the underlying socket so TCP keepalive can be enabled on a client that was checked out of a pool we did not configure. Optional (and defensively typed) because it is an implementation detail of pg.

    • Parameters

      Returns this

    • Parameters

      • event: "error"
      • listener: (err: Error) => void

      Returns this

    • Parameters

      • event: "end"
      • listener: () => void

      Returns this

    • Type Parameters

      • R = any

      Parameters

      • text: string
      • Optionalparams: readonly unknown[]

      Returns Promise<PgQueryResult<R>>

    • Parameters

      • Optionaldestroy: boolean

      Returns void

    • Parameters

      • Optionalevent: string

      Returns this

    • Parameters

      Returns this

    Settings
    Member Visibility

    On This Page
    Properties
    Methods