Interface IZDatabaseServer<TDatabase>

Represents a server that runs an in-memory database.

The implementation of the server acts as a factory to construct the client connections to the in memory database.

interface IZDatabaseServer {
    running(): Promise<boolean>;
    start(options?): Promise<TDatabase>;
    stop(): Promise<boolean>;
}

Type Parameters

TDatabase
The type of database that will be returned when the server is started.

Implemented by

Index

Methods

running start stop

Methods

running

running(): Promise<boolean>
Gets whether the database server is running.

Returns Promise<boolean>
True if the server is running. False otherwise.
- Defined in database-server/database-server.ts:20

start

start(options?): Promise<TDatabase>
Starts the server.
Parameters
- Optional options: IZDatabaseOptions
  Optional options to use when starting the database.
Returns Promise<TDatabase>
The client that is connected or can connect to the server.
- Defined in database-server/database-server.ts:31

stop

stop(): Promise<boolean>
Stops the server.

Returns Promise<boolean>
True if the server is stopped. False otherwise.
- Defined in database-server/database-server.ts:38

Generated using TypeDoc