Skip to content

Commit d9a6751

Browse files
committed
docs: fix MongoMemoryServer typo in readme
Closes #92
1 parent 232bed0 commit d9a6751

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This package spins up a actual/real MongoDB Server programmatically from node fo
1111

1212
This package on first start downloads the latest MongoDB binaries and save it to `~/.mongodb-binaries` folder. So first run may take a time. All further runs will fast, because use already downloaded binaries.
1313

14-
Every `MongodbMemoryServer` instance creates and starts fresh MongoDB server on some free port. You may start up several mongod simultaneously. When you terminate your script or call `stop()` MongoDB server(s) will be automatically shutdown.
14+
Every `MongoMemoryServer` instance creates and starts fresh MongoDB server on some free port. You may start up several mongod simultaneously. When you terminate your script or call `stop()` MongoDB server(s) will be automatically shutdown.
1515

1616
Perfectly [works with Travis CI](https://github.com/nodkz/graphql-compose-mongoose/commit/7a6ac2de747d14281f9965f418065e97a57cfb37) without additional `services` and `addons` options in `.travis.yml`.
1717

@@ -26,9 +26,9 @@ npm install mongodb-memory-server --save-dev
2626

2727
### Simple server start:
2828
```js
29-
import MongodbMemoryServer from 'mongodb-memory-server';
29+
import MongoMemoryServer from 'mongodb-memory-server';
3030

31-
const mongod = new MongodbMemoryServer();
31+
const mongod = new MongoMemoryServer();
3232

3333
const uri = await mongod.getConnectionString();
3434
const port = await mongod.getPort();
@@ -45,7 +45,7 @@ mongod.stop();
4545
### Available options
4646
All options are optional.
4747
```js
48-
const mongod = new MongodbMemoryServer({
48+
const mongod = new MongoMemoryServer({
4949
instance: {
5050
port?: ?number, // by default choose any free port
5151
ip?: string, // by default '127.0.0.1', for binding to all IP addresses set it to `::,0.0.0.0`,
@@ -135,9 +135,9 @@ Take a look at this [test file](https://github.com/nodkz/mongodb-memory-server/b
135135
### Provide connection string to mongoose
136136
```js
137137
import mongoose from 'mongoose';
138-
import MongodbMemoryServer from 'mongodb-memory-server';
138+
import MongoMemoryServer from 'mongodb-memory-server';
139139

140-
const mongoServer = new MongodbMemoryServer();
140+
const mongoServer = new MongoMemoryServer();
141141

142142
mongoose.Promise = Promise;
143143
mongoServer.getConnectionString().then((mongoUri) => {
@@ -169,12 +169,12 @@ For additional information I recommend you to read this article [Testing a Graph
169169
### Several mongoose connections simultaneously
170170
```js
171171
import mongoose from 'mongoose';
172-
import MongodbMemoryServer from 'mongodb-memory-server';
172+
import MongoMemoryServer from 'mongodb-memory-server';
173173

174174
mongoose.Promise = Promise;
175175

176-
const mongoServer1 = new MongodbMemoryServer();
177-
const mongoServer2 = new MongodbMemoryServer();
176+
const mongoServer1 = new MongoMemoryServer();
177+
const mongoServer2 = new MongoMemoryServer();
178178

179179
// Firstly create connection objects, which you may import in other files and create mongoose models.
180180
// Connection to databases will be estimated later (after model creation).
@@ -262,13 +262,13 @@ Start Mocha with `--timeout 60000` cause first download of MongoDB binaries may
262262
263263
```js
264264
import mongoose from 'mongoose';
265-
import MongodbMemoryServer from 'mongodb-memory-server';
265+
import MongoMemoryServer from 'mongodb-memory-server';
266266

267267
let mongoServer;
268268
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
269269

270270
before((done) => {
271-
mongoServer = new MongodbMemoryServer();
271+
mongoServer = new MongoMemoryServer();
272272
mongoServer.getConnectionString().then((mongoUri) => {
273273
return mongoose.connect(mongoUri, opts, (err) => {
274274
if (err) done(err);
@@ -293,7 +293,7 @@ describe('...', () => {
293293
### Simple Jest test example
294294
```js
295295
import mongoose from 'mongoose';
296-
import MongodbMemoryServer from 'mongodb-memory-server';
296+
import MongoMemoryServer from 'mongodb-memory-server';
297297

298298
// May require additional time for downloading MongoDB binaries
299299
jasmine.DEFAULT_TIMEOUT_INTERVAL = 60000;
@@ -302,7 +302,7 @@ let mongoServer;
302302
const opts = { useMongoClient: true }; // remove this option if you use mongoose 5 and above
303303

304304
beforeAll(async () => {
305-
mongoServer = new MongodbMemoryServer();
305+
mongoServer = new MongoMemoryServer();
306306
const mongoUri = await mongoServer.getConnectionString();
307307
await mongoose.connect(mongoUri, opts, (err) => {
308308
if (err) console.error(err);

0 commit comments

Comments
 (0)