style(MongoInstance): rename interface to have an better name

Author: hasezoey

packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts

@@ -15,7 +15,7 @@ import debug from 'debug';
 import { MongoClient, MongoError } from 'mongodb';
 import {
   MongoInstanceEvents,
-  MongoMemoryInstanceProp,
+  MongoMemoryInstanceOpts,
   MongoMemoryInstanceOptsBase,
   StorageEngine,
 } from './util/MongoInstance';
@@ -253,8 +253,8 @@ export class MongoMemoryReplSet extends EventEmitter {
    * Returns instance options suitable for a MongoMemoryServer.
    * @param baseOpts Options to merge with
    */
-  protected getInstanceOpts(baseOpts: MongoMemoryInstanceOptsBase = {}): MongoMemoryInstanceProp {
-    const opts: MongoMemoryInstanceProp = {
+  protected getInstanceOpts(baseOpts: MongoMemoryInstanceOptsBase = {}): MongoMemoryInstanceOpts {
+    const opts: MongoMemoryInstanceOpts = {
       // disable "auth" if replsetopts has an object-auth
       auth:
         typeof this._replSetOpts.auth === 'object' && !this._ranCreateAuth
@@ -576,7 +576,7 @@ export class MongoMemoryReplSet extends EventEmitter {
    * Create the one Instance (without starting them)
    * @param instanceOpts Instance Options to use for this instance
    */
-  protected _initServer(instanceOpts: MongoMemoryInstanceProp): MongoMemoryServer {
+  protected _initServer(instanceOpts: MongoMemoryInstanceOpts): MongoMemoryServer {
     const serverOpts: MongoMemoryServerOpts = {
       binary: this._binaryOpts,
       instance: instanceOpts,

packages/mongodb-memory-server-core/src/MongoMemoryServer.ts

@@ -11,7 +11,7 @@ import {
 } from './util/utils';
 import MongoInstance, {
   MongodOpts,
-  MongoMemoryInstanceProp,
+  MongoMemoryInstanceOpts,
   StorageEngine,
 } from './util/MongoInstance';
 import { MongoBinaryOpts } from './util/MongoBinary';
@@ -29,7 +29,7 @@ tmp.setGracefulCleanup();
  * MongoMemoryServer Stored Options
  */
 export interface MongoMemoryServerOpts {
-  instance?: MongoMemoryInstanceProp;
+  instance?: MongoMemoryInstanceOpts;
   binary?: MongoBinaryOpts;
   spawn?: SpawnOptions;
   /**

packages/mongodb-memory-server-core/src/__tests__/replset-single.test.ts

@@ -6,7 +6,7 @@ import MongoMemoryReplSet, {
 import { MongoClient } from 'mongodb';
 import MongoMemoryServer from '../MongoMemoryServer';
 import * as utils from '../util/utils';
-import { MongoMemoryInstanceProp } from '../util/MongoInstance';
+import { MongoMemoryInstanceOpts } from '../util/MongoInstance';
 
 jasmine.DEFAULT_TIMEOUT_INTERVAL = 600000;
 
@@ -427,7 +427,7 @@ describe('MongoMemoryReplSet', () => {
     expect(
       // @ts-expect-error because "getInstanceOpts" is protected
       replSet.getInstanceOpts({ storageEngine: 'wiredTiger' })
-    ).toMatchObject<MongoMemoryInstanceProp>({
+    ).toMatchObject<MongoMemoryInstanceOpts>({
       // this is needed, otherwise no ts error when "storageEngine" might get changed
       storageEngine: 'wiredTiger',
     });

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

@@ -24,9 +24,7 @@ export interface MongoMemoryInstanceOptsBase {
   storageEngine?: StorageEngine;
 }
 
-// TODO: find an better name for this interface
-// TODO: find a way to unify with "MongoInstanceOpts"
-export interface MongoMemoryInstanceProp extends MongoMemoryInstanceOptsBase {
+export interface MongoMemoryInstanceOpts extends MongoMemoryInstanceOptsBase {
   auth?: boolean;
   dbName?: string;
   ip?: string; // for binding to all IP addresses set it to `::,0.0.0.0`, by default '127.0.0.1'
@@ -52,7 +50,7 @@ export enum MongoInstanceEvents {
 
 export interface MongodOpts {
   // instance options
-  instance: MongoMemoryInstanceProp;
+  instance: MongoMemoryInstanceOpts;
 
   // mongo binary options
   binary: MongoBinaryOpts;
@@ -75,7 +73,7 @@ export interface MongoInstance extends EventEmitter {
 export class MongoInstance extends EventEmitter {
   // Mark these values as "readonly" & "Readonly" because modifying them after starting will have no effect
   // readonly is required otherwise the property can still be changed on the root level
-  instanceOpts: MongoMemoryInstanceProp;
+  instanceOpts: MongoMemoryInstanceOpts;
   readonly binaryOpts: Readonly<MongoBinaryOpts>;
   readonly spawnOpts: Readonly<SpawnOptions>;