docs(replset-opts): add file

Author: hasezoey

docs/api/classes/mongo-memory-replset.md

@@ -206,7 +206,7 @@ Will Throw an Error if `state` is not `stopped`
 
 Typings: `protected _replSetOpts!: Required<ReplSetOpts>`
 
-Stores the options used for the ReplSet Initiation
+Stores the options used for the ReplSet Initiation, uses [`ReplSetOpts`](../interfaces/replset-opts.md).
 
 ### _keyfiletmp
 

docs/api/interfaces/replset-opts.md

@@ -0,0 +1,93 @@
+---
+id: replset-opts
+title: 'ReplSetOpts'
+---
+
+API Documentation of `ReplSetOpts`-Interface
+
+## Values
+
+### auth
+
+Typings: `auth?: boolean | AutomaticAuth`  
+Default: `false`
+
+Set wheter to enable Authentication, with configuration from [`AutomaticAuth`](./mongo-memory-server-automaticauth.md).
+
+Also see [`MongoMemoryInstanceOpts.auth`](./mongo-memory-instance-opts.md#auth).
+
+### args
+
+Typings: `args?: string[]`  
+Default: `[]`
+
+Set custom arguments to passs to the `mongod` binary.
+
+Also see [`MongoMemoryInstanceOpts.args`](./mongo-memory-instance-opts.md#args).
+
+### dbName
+
+Typings: `dbName?: string`  
+Default: `""`
+
+**Currently unused**.
+
+Set a custom dbname to use in `getUri`.
+
+Also see [`MongoMemoryInstanceOpts.dbName`](./mongo-memory-instance-opts.md#dbname).
+
+### ip
+
+Typings: `ip?: string`  
+Default: `"127.0.0.1"`
+
+Set which ip to bind to.
+
+Also see [`MongoMemoryInstanceOpts.ip`](./mongo-memory-instance-opts.md#ip).
+
+### name
+
+Typings: `name?: string`  
+Default: `"testset"`
+
+Set which replset name to use.
+
+See [MongoDB `replication.replSetName`](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-replication.replSetName)
+
+### spawn
+
+Typings: `spawn?: SpawnOptions`  
+Default: `{}`
+
+Set extra spawn options to pass to `childProcess.spawn`.
+
+Also see [`MongoMemoryInstanceOpts.spawn`](./mongo-memory-instance-opts.md#spawn).
+
+### storageEngine
+
+Typings: `storageEngine?: StorageEngine`  
+Default: `"ephemeralForTest"`
+
+Set which Storage Engine to use, uses [`StorageEngine`](./mongo-memory-instance-opts.md#helper-type-storageengine).
+
+Also see [`MongoMemoryInstanceOpts.storageEngine`](./mongo-memory-instance-opts.md#storageengine).
+
+### configSettings
+
+Typings: `configSettings?: MongoMemoryReplSetConfigSettings`  
+Default: `{}`
+
+Set custom ReplSet config options
+
+See [MongoDB Replica Set Configuration](https://www.mongodb.com/docs/manual/reference/replica-configuration/).
+
+### count
+
+Typings: `count?: number`  
+Default: `1`
+
+Set how many ReplSet members to spawn, this number will be deducted from length of [`instanceOpts`](./mongo-memory-replset-opts.md#instanceopts) array.
+
+:::tip
+It is recommended to set this number to a **odd** number, and try to never have it be **even**, see [MongoDB Deploy an Odd Number of Members](https://www.mongodb.com/docs/v5.2/core/replica-set-architectures/#deploy-an-odd-number-of-members).
+:::

website/sidebars.js

@@ -17,6 +17,7 @@ module.exports = {
       'api/interfaces/mongo-memory-instance-replicamemberconfig',
       'api/interfaces/mongo-memory-binary-opts',
       'api/interfaces/mongo-memory-replset-opts',
+      'api/interfaces/replset-opts',
     ],
   },
   guides: {