Skip to content

Commit 7ac9728

Browse files
committed
style(MongoInstance): add tsdoc to the variables in "Mongoinstance"
1 parent 38d1de8 commit 7ac9728

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

packages/mongodb-memory-server-core/src/util/MongoInstance.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,28 @@ export default interface MongoInstance extends EventEmitter {
6161

6262
/**
6363
* MongoDB Instance Handler Class
64+
* This Class starts & stops the "mongod" process directly and handles stdout, sterr and close events
6465
*/
6566
export default class MongoInstance extends EventEmitter {
6667
instanceOpts: MongoInstanceOpts;
6768
binaryOpts: MongoBinaryOpts;
6869
spawnOpts: SpawnOptions;
6970

71+
/**
72+
* The "mongod" Process reference
73+
*/
7074
childProcess?: ChildProcess;
75+
/**
76+
* The "mongo_killer" Process reference
77+
*/
7178
killerProcess?: ChildProcess;
79+
/**
80+
* This boolean is "true" if the instance is elected to be PRIMARY
81+
*/
7282
isInstancePrimary: boolean = false;
83+
/**
84+
* This boolean is "true" if the instance is successfully started
85+
*/
7386
isInstanceReady: boolean = false;
7487

7588
constructor(opts: Partial<MongodOpts>) {

0 commit comments

Comments
 (0)