mirror of
https://github.com/hanzoai/mongodb-memory-server.git
synced 2026-09-24 17:00:24 +00:00
docs(mongo-memory-replset-states): add file
This commit is contained in:
@@ -29,7 +29,7 @@ Create an new ReplSet and start it (while being an Promise)
|
||||
|
||||
Typings: `protected stateChange(newState: MongoMemoryReplSetStates, ...args: any[]): void`
|
||||
|
||||
Used to change the state of the class, it is `protected` to not accidentally use it
|
||||
Used to change the state of the class, uses [`MongoMemoryReplSetStates` enum](../enums/mongo-memory-replset-states.md), it is `protected` to not accidentally use it
|
||||
|
||||
### getInstanceOpts
|
||||
|
||||
@@ -232,7 +232,7 @@ Will Throw an Error if `state` is not `stopped`
|
||||
|
||||
Typings: `protected _state: MongoMemoryReplSetStates`
|
||||
|
||||
Stores the current State
|
||||
Stores the current State, uses [`MongoMemoryReplSetStates` enum](../enums/mongo-memory-replset-states.md).
|
||||
|
||||
### _ranCreateAuth
|
||||
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
id: mongo-memory-replset-states
|
||||
title: 'MongoMemoryReplSetStates'
|
||||
---
|
||||
|
||||
API Documentation of `MongoMemoryReplSetStates`-Enum
|
||||
|
||||
## Members
|
||||
|
||||
### init
|
||||
|
||||
Value: `init`
|
||||
|
||||
Indicates that the instance is currently starting.
|
||||
|
||||
### running
|
||||
|
||||
Value: `running`
|
||||
|
||||
Indicates that the instance is currently running.
|
||||
|
||||
### stopped
|
||||
|
||||
Value: `stopped`
|
||||
|
||||
Indicates that the instance is currently stopped.
|
||||
+1
-1
@@ -8,7 +8,7 @@ module.exports = {
|
||||
'api/classes/mongo-binary',
|
||||
'api/classes/dry-mongo-binary',
|
||||
],
|
||||
Enums: ['api/enums/mongo-memory-server-states'],
|
||||
Enums: ['api/enums/mongo-memory-server-states', 'api/enums/mongo-memory-replset-states'],
|
||||
},
|
||||
guides: {
|
||||
'Getting Started': [
|
||||
|
||||
Reference in New Issue
Block a user