Interface PostgresObject

interface PostgresObject {
    clear(): void;
    create(id?, options?): Promise<PostgresInstance>;
    delete(id): void;
    forEach(cb): void;
    get(id): undefined | PostgresInstance;
    has(id): boolean;
    ids(): string[];
    instances(): PostgresInstance[];
    stop(id): Promise<void>;
    stopAll(): Promise<void>;
}

Methods

clear create delete forEach get has ids instances stop stopAll

Methods

clear

  • clear(): void

  • Clear all postgres instances exist.

    Returns void

create

delete

  • delete(id): void

  • Delete a postgres instance.

    Parameters

    • id: string

      instance id.

    Returns void

forEach

  • forEach(cb): void

  • Loop through all the postgres instances.

    Parameters

    • cb: ((instance, id, postgres) => void)

    Returns void

get

has

  • has(id): boolean

  • Check if a postgres instance exist.

    Parameters

    • id: string

      instance id.

    Returns boolean

ids

  • ids(): string[]

  • Get all the postgres instances id.

    Returns string[]

instances

stop

  • stop(id): Promise<void>

  • Stop a postgres instance.

    Parameters

    • id: string

      instance id.

    Returns Promise<void>

stopAll

  • stopAll(): Promise<void>

  • Stop all postgres instances.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

clearcreatedeleteforEachgethasidsinstancesstopstopAll

Generated using TypeDoc