Skip to content

Commit dc6b4c8

Browse files
committed
docs(mongo-memory-replset-opts): add file
1 parent edb003f commit dc6b4c8

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
id: mongo-memory-replset-opts
3+
title: 'MongoMemoryReplSetOpts'
4+
---
5+
6+
API Documentation of `MongoMemoryReplSetOpts`-Interface
7+
8+
## Values
9+
10+
### instanceOpts
11+
12+
Typings: `instanceOpts: MongoMemoryInstanceOptsBase[]`
13+
Default: `{}`
14+
15+
Set [`MongoMemoryInstanceOptsBase`](./mongo-memory-instance-opts.md#values-for-mongomemoryinstanceoptsbase) for a instance individually, overwrites existing options from [`replSet`](#replset).
16+
17+
The count of this array deducts from the `replSet.count`, if more than `replSet.count` are specified, the additional ones are also spawned.
18+
19+
### binary
20+
21+
Typings: `binary: MongoBinaryOpts`
22+
Default: `{}`
23+
24+
Set [`MongoBinaryOpts`](./mongo-binary-opts.md) for the replset instances to use.
25+
26+
### replSet
27+
28+
Typings: `replSet: ReplSetOpts`
29+
Default: `{}`
30+
31+
Set [`ReplSetOpts`](./replset-opts.md) for the whole ReplSet and default options for the instances to spawn with.

website/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ module.exports = {
1616
'api/interfaces/mongo-memory-instance-opts',
1717
'api/interfaces/mongo-memory-instance-replicamemberconfig',
1818
'api/interfaces/mongo-memory-binary-opts',
19+
'api/interfaces/mongo-memory-replset-opts',
1920
],
2021
},
2122
guides: {

0 commit comments

Comments
 (0)