Enmap-Mongo

Enmap-Mongo is a provider for the Enmap module.

Installation

To install Enmap-Mongo simply run npm i enmap-mongo.

Usage

1// Load Enmap
2const Enmap = require('enmap');
3 
4// Load EnmapMongo
5const EnmapMongo = require('enmap-mongo');
6 
7// Initialize the provider
8const Provider = new EnmapMongo({ name: 'test' });
9 
10// Initialize the Enmap with the provider instance.
11const myColl = new Enmap({ provider: provider });

Shorthand declaration:

1const Enmap = require('enmap');
2const EnmapMongo = require('enmap-mongo');
3const myColl = new Enmap({ provider: new EnmapMongo({ name: 'test' }); });

Options

1// Example with all options.
2const level = new EnmapMongo({ 
3  name: 'test',
4  dbName: 'enmap',
5  user: 'username',
6  pass: 'password',
7  host: 'localhost',
8  port: 27017
9});

1// Example with full URL.
2const level = new EnmapMongo({ 
3  name: 'test',
4  dbName: 'enmap',
5  url: 'mongodb://username:password@localhost:27017/enmap'
6});

name

The name option is mandatory and defines the name of the collection where the data is stored.

dbName

The dbName is optional and defines the database where data is stored. If multiple enmap instances connect to the same database, the same database is used with different table collections. The default database is enmap.

host

The host is optional and defines which host this module attempts to connect to. The default host is localhost.

port

The port is optional and defines which port is used to connect to the Rethink DB. The default port is 27017.

user, pass

Optional, used for authentication. Needs both to work, or neither.

url

Optional. If used, the host, port, user and pass options are ignored , and url is used instead. Note that the /dbname at the end of your url must correspond to the dbName value (or enmap).