Wondering what’s next for npm?Check out our public roadmap! »

fortune-mongodb

1.3.2 • Public • Published

Fortune MongoDB Adapter

Build Status npm Version License

This is a MongoDB adapter for Fortune. It uses the official Node.js MongoDB driver internally.

Usage

Install the fortune-mongodb package from npm:

$ npm install fortune-mongodb

Then use it with Fortune:

const fortune = require('fortune')
const mongodbAdapter = require('fortune-mongodb')
 
const store = fortune({ ... }, {
  adapter: [
    mongodbAdapter,
    {
      // options object, URL is mandatory.
      url: 'mongodb://localhost:27017/test'
    }
  ]
})

Options

Adapter options:

  • url: MongoDB connection URL. Required.
  • enableTransactions: Use transactions for handling requests, this requires MongoDB to be using a replica set. Default: false.
  • generateId: Generate the _id key on a new document. It must be a function that accepts one argument, the record type, and returns a unique string or number. Optional.
  • typeMap: An object that maps type names (keys) to MongoDB collection names (values). For example, { user: 'users' }.

For driver options, see the official documentation for details.

In addition to the constructor options, there is also the query function in the find method, which accepts the query object as an argument, and may either mutate or return the query object. This allows for arbitrary queries.

License

This software is licensed under the MIT License.

Install

npm i fortune-mongodb

DownloadsWeekly Downloads

45

Version

1.3.2

License

MIT

Unpacked Size

18.7 kB

Total Files

6

Last publish

Collaborators

  • avatar