2.0.7

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@pushrocks/smartmongo",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pushrocks/smartmongo",
-      "version": "2.0.6",
+      "version": "2.0.7",
       "license": "MIT",
       "dependencies": {
         "@pushrocks/mongodump": "^1.0.7",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartmongo",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "private": false,
   "description": "create a local mongodb for testing",
   "main": "dist_ts/index.js",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@pushrocks/smartmongo',
-  version: '2.0.6',
+  version: '2.0.7',
   description: 'create a local mongodb for testing'
 }

ts/index.ts

@@ -30,6 +30,10 @@ export class SmartMongo {
     console.log(`@pushrocks/smartmongo version ${commitinfo.version}`);
   }
 
+  /**
+   * returns a mongo descriptor for modules like
+   * @pushrocks/smartfile.
+   */
   public async getMongoDescriptor(): Promise<plugins.smartdata.IMongoDescriptor> {
     await this.readyPromise;
     return {
@@ -38,11 +42,19 @@ export class SmartMongo {
     };
   }
 
+  /**
+   * stops the smartmongo instance
+   * and cleans up after itself
+   */
   public async stop() {
     await this.mongoReplicaSet.stop();
     await this.mongoReplicaSet.cleanup();
   }
 
+  /**
+   * like stop() but allows you to actually store
+   * the database on disk
+   */
   public async stopAndDumpToDir(dirArg: string, nameFunctionArg?: (doc: any) => string, emptyDirArg = true) {
     const mongodumpInstance = new plugins.mongodump.MongoDump();
     const mongodumpTarget = await mongodumpInstance.addMongoTargetByMongoDescriptor(await this.getMongoDescriptor());