Giter Site home page Giter Site logo

fortune-mongodb's Introduction

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.
  • 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.