MongoDB Memory Server

https://typegoose.github.io/mongodb-memory-server/docs
Admin
MongoDB Memory Server spins up and manages in-memory MongoDB server binaries with zero or minimal...
Tokens:11,552
Snippets:180
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### async start(): Promise<void>

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Starts the replica set.

```APIDOC
## async start(): Promise<void>

### Description
Starts a new ReplSet or restarts a stopped one. Throws an error if the ReplSet is already running.
```

--------------------------------

### start()

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-instance

Starts the mongod and watcher processes.

```APIDOC
## async start()

### Description
Starts the mongod process and the associated watcher processes.
```

--------------------------------

### async start(forceSamePort: boolean = false)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-server

Starts a new instance or restarts a stopped instance.

```APIDOC
## async start(forceSamePort: boolean = false)

### Description
Starts the MongoDB instance. If forceSamePort is true, it attempts to reuse the previous port if available.

### Parameters
- **forceSamePort** (boolean) - Optional - Whether to attempt to reuse the previous port.
```

--------------------------------

### Install libcurl4 on Docker images

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/known-issues

Install the required libcurl4 dependency to ensure MongoDB binaries start correctly on custom or older Docker images.

```bash
apt-get install libcurl4
```

--------------------------------

### Start a Normal Server

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide

Initializes and starts a new MongoMemoryServer instance, retrieves its connection URI, and stops the server.

```typescript
import { MongoMemoryServer } from 'mongodb-memory-server';  

  

// This will create an new instance of "MongoMemoryServer" and automatically start it  

const mongod = await MongoMemoryServer.create();  

  

const uri = mongod.getUri();  

  

// The Server can be stopped again with  

await mongod.stop();  
```

--------------------------------

### static async create(opts?: MongoMemoryServerOpts)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-server

Creates and starts a new MongoMemoryServer instance.

```APIDOC
## static async create(opts?: MongoMemoryServerOpts)

### Description
Creates a new instance and starts it immediately. Returns a Promise that resolves to the started MongoMemoryServer instance.

### Parameters
- **opts** (MongoMemoryServerOpts) - Optional - Configuration options for the memory server.
```

--------------------------------

### Configure Vitest Global Setup

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Defines the Vitest configuration and global setup file to manage the MongoDB instance lifecycle across test projects.

```typescript
import { defineConfig } from 'vitest/config';  

  

export default defineConfig({  

  test: {  

    globalSetup: ['./globalSetup.ts'],  

  },  

});  
```

```typescript
import type { TestProject } from 'vitest/node';  

import { MongoMemoryServer } from 'mongodb-memory-server';  

  

declare module 'vitest' {  

  export interface ProvidedContext {  

    MONGO_URI: string;  

  }  

}  

  

export default async function setup({ provide }: TestProject) {  

  const mongod = await MongoMemoryServer.create();  

  

  const uri = mongod.getUri();  

  

  provide('MONGO_URI', uri);  

  

  return async () => {  

    await mongod.stop();  

  };  

}  
```

--------------------------------

### MongoInstance.create(opts: Partial<MongodOpts>)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-instance

Static method to create and start a new MongoDB instance.

```APIDOC
## static async create(opts: Partial<MongodOpts>)

### Description
Creates a new MongoInstance and starts the underlying mongod process.

### Parameters
- **opts** (Partial<MongodOpts>) - Optional - Configuration options for the MongoDB instance.

### Returns
- **Promise<MongoInstance>** - A promise that resolves to the started MongoInstance.
```

--------------------------------

### constructor(opts?: MongoMemoryServerOpts)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-server

Creates a new instance of MongoMemoryServer without starting it.

```APIDOC
## constructor(opts?: MongoMemoryServerOpts)

### Description
Creates a new instance of MongoMemoryServer without starting it. Use this to initialize the server configuration before starting.

### Parameters
- **opts** (MongoMemoryServerOpts) - Optional - Configuration options for the memory server.
```

--------------------------------

### Configure environment setup file

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Handles database connection and disconnection logic for individual test suites.

```typescript

beforeAll(async () => {  

  // put your client connection code here, example with mongoose:  

  await mongoose.connect(process.env['MONGO_URI']);  

});  

  

afterAll(async () => {  

  // put your client disconnection code here, example with mongoose:  

  await mongoose.disconnect();  

});  

  


```

--------------------------------

### Configure Jest settings

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

The jest.config.json file specifying global setup, teardown, and environment setup files.

```json

{  

  "preset": "ts-jest",  

  "globalSetup": "<rootDir>/test/globalSetup.ts",  

  "globalTeardown": "<rootDir>/test/globalTeardown.ts",  

  "setupFilesAfterEnv": [  

    "<rootDir>/test/setupFile.ts"  

  ]  

}  

  


```

--------------------------------

### Configure Vitest with vitest-mms

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Alternative configuration using the vitest-mms helper package to simplify global setup.

```typescript
import { defineConfig } from 'vitest/config';  

  

export default defineConfig({  

  test: {  

    globalSetup: ['vitest-mms/globalSetup'],  

  },  

});  
```

--------------------------------

### Implement Jest global setup

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Initializes the MongoMemoryServer instance and sets the environment variable for test suites.

```typescript

import { MongoMemoryServer } from 'mongodb-memory-server';  

import * as mongoose from 'mongoose';  

import { config } from './utils/config';  

  

export = async function globalSetup() {  

  if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used  

    // it's needed in global space, because we don't want to create a new instance every test-suite  

    const instance = await MongoMemoryServer.create();  

    const uri = instance.getUri();  

    (global as any).__MONGOINSTANCE = instance;  

    process.env.MONGO_URI = uri.slice(0, uri.lastIndexOf('/'));  

  } else {  

    process.env.MONGO_URI = `mongodb://${config.IP}:${config.Port}`;  

  }  

  

  // The following is to make sure the database is clean before a test suite starts  

  const conn = await mongoose.connect(`${process.env.MONGO_URI}/${config.Database}`);  

  await conn.connection.db.dropDatabase();  

  await mongoose.disconnect();  

};  

  


```

--------------------------------

### constructor(opts: Partial<MongoMemoryReplSetOpts> = {})

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Creates a new MongoMemoryReplSet instance without starting it.

```APIDOC
## constructor(opts: Partial<MongoMemoryReplSetOpts> = {})

### Description
Creates a new ReplSet instance without starting it. Use this if you need to configure the instance before starting it manually.

### Parameters
- **opts** (Partial<MongoMemoryReplSetOpts>) - Optional - Configuration options for the replica set.
```

--------------------------------

### static async create(opts?: Partial<MongoMemoryReplSetOpts>): Promise<MongoMemoryReplSet>

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Creates and starts a new MongoMemoryReplSet.

```APIDOC
## static async create(opts?: Partial<MongoMemoryReplSetOpts>): Promise<MongoMemoryReplSet>

### Description
Creates a new ReplSet and starts it immediately, returning a promise that resolves to the instance.

### Parameters
- **opts** (Partial<MongoMemoryReplSetOpts>) - Optional - Configuration options for the replica set.
```

--------------------------------

### Enable Debug Mode for npm postinstall scripts

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/enable-debug-mode

Use the --foreground-scripts flag to force npm to output logs from postinstall scripts during installation.

```bash

# Change scripts to be executed on the NPM main proccess instead of workers AND log script output  

MONGOMS_DEBUG=1 npm install --foreground-scripts  


```

--------------------------------

### Update instance initialization

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7

Use the static create method instead of the constructor to start a new MongoMemoryServer instance.

```javascript
// this no longer works  

const mongo = new MongoMemoryServer();  

const uri = await mongo.getUri(); // ERROR: instance not started  

  

// it is now  

const mongo = await MongoMemoryServer.create();  

const uri = mongo.getUri();  
```

--------------------------------

### Install libcurl dependencies for Debian

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/docker

Required for Debian-based images to resolve MongoDB binary dependency issues.

```bash
apt-get install libcurl4 # for Debian 10+ to fix CURL_OPENSSL_4  

# OR  

apt-get install libcurl3 # for Debian 9 (and before) to fix CURL_OPENSSL_3
```

--------------------------------

### Start a ReplicaSet

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide

Initializes a MongoMemoryReplSet with a specified number of members, optionally configuring the storage engine for transaction support.

```typescript
import { MongoMemoryReplSet } from 'mongodb-memory-server';  

  

// This will create an new instance of "MongoMemoryReplSet" and automatically start all Servers  

const replset = await MongoMemoryReplSet.create({ replSet: { count: 4 } }); // This will create an ReplSet with 4 members  

// To use Transactions, the "storageEngine" needs to be changed to `wiredTiger`  

const replset = await MongoMemoryReplSet.create({ replSet: { count: 4, storageEngine: 'wiredTiger' } }); // This will create an ReplSet with 4 members and storage-engine "wiredTiger"  

  

const uri = replset.getUri();  

  

// The ReplSet can be stopped again with  

await replset.stop();  
```

--------------------------------

### new MongoInstance(opts: Partial<MongodOpts>)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-instance

Creates a new instance of the MongoInstance class without starting the underlying process.

```APIDOC
## constructor(opts: Partial<MongodOpts>)

### Description
Creates a new instance of the MongoInstance class. This does not start the MongoDB process; use the create method for starting the instance immediately.

### Parameters
- **opts** (Partial<MongodOpts>) - Optional - Configuration options for the MongoDB instance.
```

--------------------------------

### Consume MongoDB URI in Vitest Tests

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Injects the MONGO_URI provided by the global setup into individual test files.

```javascript
import { inject, test } from 'vitest';  

import { MongoClient } from 'mongodb';  

  

const MONGO_URI = inject('MONGO_URI');  

const mongoClient = new MongoClient(MONGO_URI);  

  

beforeAll(async () => {  

  await mongoClient.connect();  

  return () => mongoClient.disconnect();  

});  

  

test('...', () => {  

  const db = mongoClient.db('my-db');  

});  
```

--------------------------------

### StateError message format

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/error-warning-details

Thrown when a function or setter is called in an invalid state, such as restarting an already started instance.

```text
Incorrect State for operation: "${gotState}", allowed States: "[${wantedStates.join(',')}]"
```

--------------------------------

### prepareCommandArgs()

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-instance

Constructs the command arguments for the mongod process.

```APIDOC
## prepareCommandArgs()

### Description
Constructs the command line arguments required to launch the mongod process based on the instance configuration.

### Returns
- **string[]** - An array of command arguments.
```

--------------------------------

### Use envName helper for configuration

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7

Replaces manual environment variable string concatenation with the envName helper for better type safety and auto-completion.

```javascript
// previously  

process.env[ENV_CONFIG_PREFIX + ResolveConfigVariables.DOWNLOAD_DIR] = 'someValue';  

  

// now  

process.env(envName(ResolveConfigVariables.DOWNLOAD_DIR)) = 'someValue';  
```

--------------------------------

### Configure via package.json

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/config-options

Define configuration options within the package.json file under the config.mongodbMemoryServer property using camelCase keys.

```json
{
  "config": {
    "mongodbMemoryServer": {
      "downloadDir": "/path/to/DownloadDir"
    }
  }
}
```

--------------------------------

### async waitUntilRunning(): Promise<void>

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Waits for all instances in the replica set to be running.

```APIDOC
## async waitUntilRunning(): Promise<void>

### Description
Blocks until all instances are confirmed to be running. Throws an error if the state is not 'running' or 'init'.
```

--------------------------------

### Configure .dockerignore

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/docker

Prevents host-specific node_modules from being copied into the image, avoiding binary conflicts.

```text
# ignore all node_modules, no matter where, like when having a monorepo  

**/node_modules
```

--------------------------------

### Recommended Dockerfile for MMS

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/docker

Standard Dockerfile configuration for building images with mongodb-memory-server, supporting both npm and yarn.

```dockerfile
# Using a Debian build  

FROM node:16  

  

# Installing "libcurl4" because some Debian images may not come with this package installed, but is required by the mongodb binaries  

RUN apt-get install libcurl4  

  

# Settings the CWD (Current Work Directory) to "/project" to have a isolated folder for the project  

# Note: it is not recommended to set it to "/home/dockeruser", but to use "/home/dockeruser/project"  

WORKDIR /project  

  

# Copy the project (all files) into the image into "/project" as user "node:node"  

# User "node:node" is the default nodejs user in the docker images  

COPY node:node . /project  

  

# Explicitly set the user that will be used for the next Instructions and ENTRYPOINT  

USER node  

  

# Install all required dependencies locked to the package-lock (or yarn.lock)  

# Replace "npm install" with your package manager command of choice  

RUN npm install --ci  

# OR  

RUN yarn install --frozen-lockfile  

  

# Set the default command that will be used when running the image  

# Replace this with your command / package manager command of choice  

ENTRYPOINT ["npm", "run", "test"]  

# OR  

ENTRYPOINT ["yarn", "run", "test"]
```

--------------------------------

### Define configuration for Jest integration

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

A sample configuration file used to determine if the memory server should be utilized.

```typescript

// this file could be anything (like a json directly imported)  

  

export = {  

  Memory: true,  

  IP: '127.0.0.1',  

  Port: '27017',  

  Database: 'somedb'  

}  



```

--------------------------------

### Enable Debug Mode via package.json

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/enable-debug-mode

Configure debug mode persistently by adding a mongodbMemoryServer object to the config section of package.json.

```json

{  

  "config": {  

    "mongodbMemoryServer": {  

      "debug": "1" // also available case-insensitive values: "on" "yes" "true"  

    }  

  }  

}  


```

--------------------------------

### async cleanup(options?: Cleanup): Promise<void>

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Cleans up files used by the replica set instances.

```APIDOC
## async cleanup(options?: Cleanup): Promise<void>

### Description
Removes all files associated with the replica set's instances.

### Parameters
- **options** (Cleanup) - Optional - Configuration for how the cleanup should be performed.
```

--------------------------------

### MongoBinary.download

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-binary

Attempts to locate the MongoDB binary and downloads it if it is not found.

```APIDOC
## static async download(options: Required<MongoBinaryOpts>): Promise<string>

### Description
Try to find the binary and if not found download the binary.

### Parameters
- **options** (Required<MongoBinaryOpts>) - Required - Configuration options for the download process.
```

--------------------------------

### UnknownPlatformError message format

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/error-warning-details

Thrown when the current operating system platform is not supported.

```text
Unknown Platform: "${platform}"
```

--------------------------------

### CreateUser Interface Definition

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-createuser

Defines the structure and properties required for the CreateUser interface.

```APIDOC
## CreateUser Interface

### Description
Defines the configuration object for creating a new user. Inherits properties from CreateUserMongoDB.

### Properties
- **database** (string) - Optional - The database where the user will be added. Defaults to 'admin'.
- **createUser** (string) - Required - The username of the user to create.
- **pwd** (string) - Required - The password for the user.
- **roles** (Array) - Required - The roles assigned to the new user. Each element can be a string (UserRoles) or an object containing { role: UserRoles; db: string }.
```

--------------------------------

### Enable automatic authentication

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7

Configures an Auth-enabled instance by providing the auth option during creation.

```javascript
// This will create an Auth-enabled instance with default auth-values  

const mongoServer = await MongoMemoryServer.create({  

  auth: {}, // anything else than "undefined / null" will enable auth, can be explicitly disabled with "auth: { disable: true }"  

  instance: {  

    auth: true,  

    storageEngine: 'wiredTiger',  

  },  

});  
```

--------------------------------

### Integrate with Mocha and Mongoose

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Uses Mocha's before and after hooks to manage the lifecycle of the in-memory MongoDB instance. Ensure the timeout is set to 60000ms to accommodate initial binary downloads.

```javascript
import mongoose from 'mongoose';  

import { MongoMemoryServer } from 'mongodb-memory-server';  

  

let mongoServer;  

  

before(async () => {  

  mongoServer = await MongoMemoryServer.create();  

  const mongoUri = mongoServer.getUri();  

  await mongoose.connect(mongoUri);  

});  

  

after(async () => {  

  await mongoose.disconnect();  

  await mongoServer.stop();  

});  

  

describe('...', () => {  

  it('...', async () => {  

    const User = mongoose.model('User', new mongoose.Schema({ name: String }));  

    const cnt = await User.countDocuments();  

    expect(cnt).to.equal(0);  

  });  

});  
```

--------------------------------

### DryMongoBinary API Methods

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/dry-mongo-binary

A collection of static methods available on the DryMongoBinary class for binary management.

```APIDOC
## locateBinary

### Description
Try to locate an existing binary without downloading or touching the filesystem much.

### Signature
`static async locateBinary(opts: DryMongoBinaryOptions): Promise<string | undefined>`

## generateOptions

### Description
Generate a full DryMongoBinaryOptions object from partial input.

### Signature
`static async generateOptions(opts?: DryMongoBinaryOptions): Promise<Required<DryMongoBinaryOptions>>`

## parseArchiveNameRegex

### Description
Parse an archive name into useable options.

### Signature
`static parseArchiveNameRegex(input: string, opts: Required<DryMongoBinaryOptions>): Required<DryMongoBinaryOptions>`

## getBinaryName

### Description
Get what the binary name should be formatted like. If USE_ARCHIVE_NAME_FOR_BINARY_NAME is true, then the archive name will be used instead of what MMS uses by default.

### Signature
`static async getBinaryName(opts: DryMongoBinaryNameOptions): Promise<string>`

## combineBinaryName

### Description
Helper function to consistently combine a basePath with the binaryName.

### Signature
`static combineBinaryName(basePath: string, binaryName: string): string`

## getSystemPath

### Description
Check if the given path has all the permissions required to be executed.

### Signature
`static async getSystemPath(systemBinary: string): Promise<string | undefined>`

## generatePaths

### Description
Get the paths where binaries may be located in.

### Signature
`static async generatePaths(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<DryMongoBinaryPaths>`

## generateDownloadPath

### Description
Get the path where the binary will be downloaded to.

### Signature
`static async generateDownloadPath(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<[boolean, string]>`
```

--------------------------------

### async stop(cleanupOptions?: Cleanup)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-server

Stops a running instance and performs cleanup.

```APIDOC
## async stop(cleanupOptions?: Cleanup)

### Description
Stops the running instance. By default, it triggers a cleanup of files used by the instance.

### Parameters
- **cleanupOptions** (Cleanup) - Optional - Configuration for the cleanup process.
```

--------------------------------

### AutomaticAuth Interface Properties

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-automaticauth

Configuration options for enabling and customizing authentication within the memory server instance.

```APIDOC
## AutomaticAuth Interface

### Properties
- **enable** (boolean) - Optional - Enable or disable Authentication creation. Default: false.
- **extraUsers** (CreateUser[]) - Optional - Add extra users after the root user has been created. Default: [].
- **customRootName** (string) - Optional - Set a Custom Root User Name. Default: "mongodb-memory-server-root".
- **customRootPwd** (string) - Optional - Set a Custom Root User Password. Default: "rootuser".
- **force** (boolean) - Optional - Force to run createAuth. By default, createAuth is only run when the instance is new. Default: false.
- **keyfileContent** (string) - Optional - Set custom content for the keyfile. Only has an effect in a MongoMemoryReplSet. Default: "0123456789".
```

--------------------------------

### getUri(otherDb?: string): string

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Retrieves the connection URI for the replica set.

```APIDOC
## getUri(otherDb?: string): string

### Description
Returns a MongoDB-compatible connection URI. If no arguments are provided, it defaults to 127.0.0.1 and includes the replica set query parameter.

### Parameters
- **otherDb** (string) - Optional - An optional database name to append to the URI.
```

--------------------------------

### MongoBinary.getPath

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-binary

Retrieves the path to a working MongoDB binary, optionally triggering a download if configured.

```APIDOC
## static async getPath(opts: MongoBinaryOpts = {}): Promise<string>

### Description
Get a working binary and returns the path to it. Calls `download` if `RUNTIME_DOWNLOAD` is `true`.

### Parameters
- **opts** (MongoBinaryOpts) - Optional - Configuration options for locating the binary.
```

--------------------------------

### Configure package.json for workspace cache

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/config-options

Use this structure in package.json to force a specific node_modules cache location, which is useful for workspace environments.

```json
{

  "name": "workspace",

  // along with your other workspace keys

  "config": {

    "mongodbMemoryServer": {

      "_": 0

    }

  }

}
```

--------------------------------

### UnableToUnlockLockfileError message format

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/error-warning-details

Thrown when the package fails to unlock a file because it is not locked by the current instance or process.

```text
Cannot unlock file "${file}", because it is not locked by this ${thisInstance ? 'instance' : 'process'}
```

--------------------------------

### Wrap async code

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide

Use this pattern to execute asynchronous code if top-level await is not supported in your environment.

```javascript
(async () => {  

  // async code in where  

})();  
```

--------------------------------

### async stop(cleanupOptions?: Cleanup): Promise<boolean>

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-replset

Stops the running replica set instances.

```APIDOC
## async stop(cleanupOptions?: Cleanup): Promise<boolean>

### Description
Stops a running instance. By default, it triggers a cleanup process.

### Parameters
- **cleanupOptions** (Cleanup) - Optional - Configuration for the cleanup process.
```

--------------------------------

### Update MongoMemoryServer authentication configuration

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate9

The instance.auth option is ignored in 9.0.0; use the top-level auth option instead.

```javascript
new MongoMemoryServer({ instance: { auth: true } })
```

```javascript
new MongoMemoryServer({ auth: { enable: true } })
```

--------------------------------

### UnknownArchitectureError message formats

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/error-warning-details

Thrown when the package detects an architecture or platform combination not supported by MongoDB.

```text
Unsupported Architecture-Platform combination: arch: "${arch}", platform: "${platform}"
```

```text
Unsupported Architecture: "${arch}"
```

--------------------------------

### Update cleanup and stop method calls

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate9

Boolean arguments for .stop() and .cleanup() have been removed in favor of object-based options.

```javascript
.stop({ doCleanup: true })
```

```javascript
.stop({ doCleanup: true, force: true })
```

--------------------------------

### stop()

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-instance

Stops the mongod and watcher processes.

```APIDOC
## async stop()

### Description
Stops the mongod process and the associated watcher processes. Does not throw an error if the instance is not currently running.

### Returns
- **Promise<boolean>** - Returns true if the stop operation was successful.
```

--------------------------------

### getUri(otherDbName?: string, otherIp?: string)

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/classes/mongo-memory-server

Retrieves the connection URI for the MongoDB instance.

```APIDOC
## getUri(otherDbName?: string, otherIp?: string)

### Description
Returns a MongoDB-compatible connection URI. Allows overriding the database name and IP address.

### Parameters
- **otherDbName** (string) - Optional - Database name to append to the URI.
- **otherIp** (string) - Optional - IP address to use instead of 127.0.0.1.
```

--------------------------------

### Customize package.json resolution path

Source: https://typegoose.github.io/mongodb-memory-server/docs/api/config-options

Override the default package.json lookup location by using the findPackageJson utility or changing the current working directory.

```typescript
import { findPackageJson } from "mongodb-memory-server-core/lib/util/resolveConfig";

findPackageJson('/custom/path');

// OR

process.chdir('/custom/path'); // not recommended
```

--------------------------------

### Update AutomaticAuth configuration

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate9

The auth object now requires an explicit enable property instead of relying on empty objects or the disable property.

```javascript
auth: { enable: true }
```

```javascript
auth: { enable: false }
```

--------------------------------

### Configure cleanup behavior in stop and cleanup methods

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/faq

Use objects to configure cleanup behavior for stop and cleanup methods, available since version 8.4.0.

```typescript
.stop({ doCleanup: false })
```

--------------------------------

### UnknownLockfileStatusError message format

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/error-warning-details

Thrown when a value outside the LockFileStatus enum is encountered.

```text
Unknown LockFile Status: "${status}"
```

--------------------------------

### Enable Debug Mode via Environment Variable

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/enable-debug-mode

Set the MONGOMS_DEBUG environment variable to enable debug output during test execution.

```bash

# also available case-insensitive values: "on" "yes" "true"  

MONGOMS_DEBUG=1 npm run test  


```

--------------------------------

### Remove node_modules in Dockerfile

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/docker

Alternative to .dockerignore that cleans up node_modules during the build process.

```dockerfile
# ...  

COPY node:node . /project  

  

# Put this Instruction between the COPY and the RUN "npm install" steps  

# The following recursively deletes all directories it finds that are a directory AND have a name matching "node_modules"  

RUN find . -type d -iname "node_modules" -exec rm -rf {} \;  

  

RUN npm install  

# ...
```

--------------------------------

### Retry logic for MongoWriteConcernError

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/common-issues

Implements a retry mechanism for database operations that fail due to interrupted write concerns, such as dropping a database.

```javascript
// original:  

async function setup(db) {  

  await db.dropDatabase();  

}  

  

// fix  

async function setup(db) {  

  let retries = 5;  

  while (retries > 0) {  

    retries -= 1;  

    try {  

      await _setup(db);  

    } catch (err) {  

      if (err instanceof mongodb.MongoWriteConcernError && /operation was interrupted/.test(err.message)) {  

        continue;  

      }  

  

      throw err;  

    }  

  }  

}  

  

async function _setup(db) {  

  await db.dropDatabase();  

}  
```

--------------------------------

### Implement Jest global teardown

Source: https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners

Stops the MongoMemoryServer instance after all tests have completed.

```typescript

import { MongoMemoryServer } from 'mongodb-memory-server';  

import { config } from './utils/config';  

  

export = async function globalTeardown() {  

  if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used  

    const instance: MongoMemoryServer = (global as any).__MONGOINSTANCE;  

    await instance.stop();  

  }  

};  

  


```
Tokens:
Raw