MongoMemoryServer
API Documentation of MongoMemoryServer-Class
Functions
new
Typings: constructor(opts?: MongoMemoryServerOpts)
Create an new Instance without starting it, uses MongoMemoryServerOpts.
When directly starting the instance, create should be used
create
Typings: static async create(opts?: MongoMemoryServerOpts): Promise<MongoMemoryServer>
Create an new Instance and start it (while being an Promise), uses MongoMemoryServerOpts.
stateChange
InternalTypings: protected stateChange(newState: MongoMemoryServerStates): void
Used to change the state of the class, uses MongoMemoryServerStates enum, it is protected to not accidentally use it.
start
Typings: async start(forceSamePort: boolean = false): Promise<boolean>
Used to start an new Instance or to Re-Start an stopped instance
with forceSamePort set to true and having instance.port set, it will use that port and not generate a new port.
with forceSamePort set to true and not having instance.port set, it will generate a new free port.
Will Error if instance is already running
getNewPort
InternalTypings: protected async getNewPort(port?: number): Promise<number>
Finds an new non-locked port, uses port if available or as a starting point.
getStartOptions
InternalTypings: protected async getStartOptions(forceSamePort: boolean = false): Promise<MongoMemoryServerGetStartOptions>
with forceSamePort set to true and having instance.port set, it will use that port and not generate a new port.
with forceSamePort set to true and not having instance.port set, it will generate a new free port.
Constructs the Starting Options
_startUpInstance
InternalTypings: async _startUpInstance(forceSamePort: boolean = false): Promise<void>
Internal Functions used by start
stop
Typings: async stop(cleanupOptions?: Cleanup): Promise<boolean>
Stop an running instance, this function will by default call .cleanup with { doCleanup: true, force: false }.
With cleanupOptions options for cleanup can be manually set.
Will not Error if instance is not running
cleanup
Typings: async cleanup(options?: Cleanup): Promise<void>
Cleanup all files used by this instance, by default { doCleanup: true, force: false } is used.
With options can be set how to run a cleanup.
ensureInstance
Typings: async ensureInstance(): Promise<MongoInstanceData>
Ensure that the instance is running, will run start if stopped, will wait if state is starting.
It is recommended to await the promise returned from start when available.
Will Error if instance cannot be started
getUri
Typings: getUri(otherDbName?: string, otherIp?: string): string
Get an mongodb-usable uri (can also be used in mongoose)
When no arguments are set, the URI will always use ip 127.0.0.1 and end with / (not setting a database).
When setting otherDbName, the value of otherDbName will be appended after / and before any query arguments.
When setting otherIp, the ip will be the value of otherIp instead of 127.0.0.1.
createAuth
InternalTypings: async createAuth(data: StartupInstanceData): Promise<void>
Logs in into the currently running instance and restarts it with auth enabled
The Instance will not be restarted if the storage engine is ephemeralForTest because data will not persist across restarts
It is still usefull if an user is always required in connection logic and mongodb throws an error that an user does not exists / cannot login
Values
instanceInfo
Typings: get instanceInfo(): MongoInstanceData | undefined
Getter for _instanceInfo
_instanceInfo
InternalTypings: protected _instanceInfo?: MongoInstanceData
Stores the instance information
opts
Typings: opts: MongoMemoryServerOpts
Store the instance options, uses MongoMemoryServerOpts.
state
Typings: get state(): MongoMemoryServerStates
Getter for _state_
_state
InternalTypings: protected _state: MongoMemoryServerStates
Stores the current State, uses MongoMemoryServerStates enum.
auth
Typings: readonly auth?: Required<AutomaticAuth>
Stores automatic auth creation options, uses AutomaticAuth with all values defined.