Class ZDatabaseServerDocument

Represents an in memory database server for document databases.

This uses mongo under the hood.

Implements

IZDatabaseServer<IZDatabaseDocument>

Index

Constructors

Properties

_client _server

Methods

running start stop

Constructors

constructor

new ZDatabaseServerDocument(): ZDatabaseServerDocument
Returns ZDatabaseServerDocument

Properties

`Private` _client

_client: null | IZDatabaseDocument

`Private` _server

_server: null | MongoMemoryServer

Methods

running

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

Returns Promise<boolean>
True if the server is running. False otherwise.
Implementation of IZDatabaseServer.running
- Defined in database-server/database-server-document.mts:15

start

start(options?): Promise<IZDatabaseDocument>
Starts the server.
Parameters
- options: IZDatabaseOptions = ...
  Optional options to use when starting the database.
Returns Promise<IZDatabaseDocument>
The client that is connected or can connect to the server.
Implementation of IZDatabaseServer.start
- Defined in database-server/database-server-document.mts:19

stop

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

Returns Promise<boolean>
True if the server is stopped. False otherwise.
Implementation of IZDatabaseServer.stop
- Defined in database-server/database-server-document.mts:32

Generated using TypeDoc