Skip to main content

@idearium/mongoose

Mongoose connection defaults.

Installation​

Please note: mongoose is a peer dependency so you'll need to add it specifically to your project.

$ yarn add -E mongoose@4.11 @idearium/mongoose

Beta installation​

If you need to install a beta version, you can:

$ yarn add -E mongoose@4.11 @idearium/mongoose@beta

Usage​

const mongoose = require('mongoose');
const { connect } = require('@idearium/mongoose');

connect({ mongoose, uri: process.env.MONGO_DB_URL, options: { ssl: process.env.MONGO_DB_SSL === 'true' } })
    .then(() => console.log('Mongoose connected to MongoDB...'))

The following are the default options:

{
    reconnectInterval: 500,
    reconnectTries: Number.MAX_VALUE,
    sslValidate: Boolean(opts.ssl || opts.tls),
    useMongoClient: true
}

These can be replaced by adding your own values in an options object.

connect({ mongoose, options = {}, uri })​

The connect function is used to connect Mongoose to MongoDB.

createConnections({ mongoose, options = {}, uris })​

The createConnections function uses mongoose.createConnection to connect Mongoose to multiple databases.

Use uris to pass in an array of MongoDB connection strings.

Examples​

Self-signed certificates​

This example shows how to use @idearium/certs to load a self-signed certificate and pass it to connect to allow making connections to MongoDB instances protected with self-signed certificates.

const mongoose = require('mongoose');
const { connect } = require('@idearium/mongoose');
const { loadProvidedCerts } = require('@idearium/certs');

module.exports = async (uri = process.env.MONGO_DB_URL, options = { ssl: process.env.MONGO_DB_SSL === 'true' }) => {

    const certs = await loadProvidedCerts('/ssl/mongo');
    const opts = certs.length ? { ...options, sslCA: certs } : options;

    return connect({
        mongoose,
        options: opts,
        uri: dbUrl
    }).then((console.log('Mongoose connected to MongoDB...')));

}

Logging​

This package uses @idearium/log. Follow the docs on how to configure it as required.