pgsql-test/connect.d.ts

pgsql-test offers isolated, role-aware, and rollback-friendly PostgreSQL environments for integration tests — giving developers realistic test coverage without external state pollution

import { PgTestConnectionOptions } from '@pgpmjs/types';
import { PgConfig } from 'pg-env';
import { DbAdmin } from './admin';
import { PgTestConnector } from './manager';
import { SeedAdapter } from './seed/types';
import { PgTestClient } from './test-client';
export declare const getPgRootAdmin: (config: PgConfig, connOpts?: PgTestConnectionOptions) => DbAdmin;
export interface GetConnectionOpts {
    pg?: Partial<PgConfig>;
    db?: Partial<PgTestConnectionOptions>;
}
export interface TeardownOptions {
    /** If true, keeps the database after closing connections (default: false) */
    keepDb?: boolean;
}
export interface GetConnectionResult {
    pg: PgTestClient;
    db: PgTestClient;
    admin: DbAdmin;
    teardown: (opts?: TeardownOptions) => Promise<void>;
    manager: PgTestConnector;
}
export declare const getConnections: (cn?: GetConnectionOpts, seedAdapters?: SeedAdapter[]) => Promise<GetConnectionResult>;