Interface ConnectionManagerContract

Connection manager to manage database connections.

interface ConnectionManagerContract {
    connections: Map<string, ConnectionNode>;
    add(connectionName: string, config: MongodbConnectionConfig): void;
    close(connectionName: string): Promise<void>;
    closeAll(): Promise<void>;
    connect(connectionName: string): void;
    get(connectionName: string): ConnectionNode;
    has(connectionName: string): boolean;
    isConnected(connectionName: string): boolean;
}

Properties

connections

Methods

add close closeAll connect get has isConnected

Properties

connections

connections: Map<string, ConnectionNode>

List of registered connections.

Methods

add

close

  • close(connectionName: string): Promise<void>

  • Close a connection.

    Parameters

    • connectionName: string

    Returns Promise<void>

closeAll

connect

  • connect(connectionName: string): void

  • Initiate a connection. It is a noop if the connection is already initiated.

    Parameters

    • connectionName: string

    Returns void

get

has

  • has(connectionName: string): boolean

  • Returns whether the connection is managed by the manager.

    Parameters

    • connectionName: string

    Returns boolean

isConnected

  • isConnected(connectionName: string): boolean

  • Returns whether the connection is connected.

    Parameters

    • connectionName: string

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods