Skip to content

Commit 55edf01

Browse files
committed
docs: small readme additions
1 parent 46a326a commit 55edf01

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ const mongod = new MongodbMemoryServer({
6666
});
6767
```
6868
69+
### Simple test with MongoClient
70+
71+
Take a look at this [test file](https://github.com/nodkz/mongodb-memory-server/blob/master/src/__tests__/singleDB-test.js).
72+
6973
### Provide connection string to mongoose
7074
```js
7175
import mongoose from 'mongoose';
@@ -79,7 +83,7 @@ mongoServer.getConnectionString().then((mongoUri) => {
7983
autoReconnect: true,
8084
reconnectTries: Number.MAX_VALUE,
8185
reconnectInterval: 1000,
82-
useMongoClient: true,
86+
useMongoClient: true, // remove this line if you use mongoose 5 and above
8387
};
8488

8589
mongoose.connect(mongoUri, mongooseOpts);
@@ -123,7 +127,7 @@ const mongooseOpts = { // options for mongoose 4.11.3 and above
123127
autoReconnect: true,
124128
reconnectTries: Number.MAX_VALUE,
125129
reconnectInterval: 1000,
126-
useMongoClient: true,
130+
useMongoClient: true, // remove this line if you use mongoose 5 and above
127131
};
128132

129133
mongoServer1.getConnectionString('server1_db1').then((mongoUri) => {
@@ -174,7 +178,7 @@ Note: When you create mongoose connection manually, you should do:
174178
```js
175179
import mongoose from 'mongoose';
176180

177-
const opts = { useMongoClient: true };
181+
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
178182
const conn = mongoose.createConnection(); // just create connection instance
179183
const User = conn.model('User', new mongoose.Schema({ name: String })); // define model
180184
conn.open(uri, opts); // open connection to database (NOT `connect` method!)
@@ -183,7 +187,7 @@ With default connection:
183187
```js
184188
import mongoose from 'mongoose';
185189

186-
const opts = { useMongoClient: true };
190+
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
187191
mongoose.connect(uri, opts);
188192
const User = mongoose.model('User', new mongoose.Schema({ name: String })); // define model
189193
```
@@ -199,7 +203,7 @@ import mongoose from 'mongoose';
199203
import MongodbMemoryServer from 'mongodb-memory-server';
200204

201205
let mongoServer;
202-
const opts = { useMongoClient: true };
206+
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
203207

204208
before((done) => {
205209
mongoServer = new MongodbMemoryServer();
@@ -233,7 +237,7 @@ import MongodbMemoryServer from 'mongodb-memory-server';
233237
jasmine.DEFAULT_TIMEOUT_INTERVAL = 60000;
234238

235239
let mongoServer;
236-
const opts = { useMongoClient: true };
240+
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
237241

238242
beforeAll(async () => {
239243
mongoServer = new MongodbMemoryServer();

0 commit comments

Comments
 (0)