JSPM

mongo-memory

0.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 24
  • Score
    100M100P100Q47473F
  • License MIT

mongodb in memory for testing or mocking

Package Exports

  • mongo-memory

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mongo-memory) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mongo Memory

NPM Downloads npm js-standard-style

Bootstrap programmatically Mongodb for testing or mocking during development.

Works on all platforms which is due to the awesome mongodb-prebuilt package.

Installation

npm install mongo-memory

Usage

const MongoInMemory = require('mongo-memory')

const port = 8000
const dbPath = "./tempb/.data" // Mongodb placed some metadata
const mongoServerInstance = new MongoMemory(port, dbPath)

mongoServerInstance.start().then(server) => {

    mongoServerInstance.getMongouri('myDatabaseName')
    mongoServerInstance.getCollection('coll1')
    mongoServerInstance.getDocumentById('myDatabaseName', 'coll1', "<id>")
    mongoServerInstance.addDocumentById('myDatabaseName', 'coll1', { a: 1, b: 2 })
    mongoServerInstance.addDirectoryOfCollections('myDatabaseName', '<path>')
    mongoServerInstance.mongodb.ObjectId
    mongoServerInstance.serialize // EJSON
    mongoServerInstance.deserialize // EJSON

})

mongoServerInstance.stop()

Run tests

$ npm run test

What about BSON Types ?

You can use the EJSON format to express BSON Types with JSON e.g ObjectId.

{
    "_id" : {
        "$oid": "ec939793b7d8fe8f9f2aa707"
    },
    'last_seen_at': {
        '$date': 1405266782008
    }
}

Background

Mongodb storageEngine ephemeralForTest is used. The connection is created by the official mongodb package.

Credits

Most code was copied from mongo-in-memory but with significant improvements:

Changes:

  • Don't save metadata in node_modules
  • Don't generate random folders
  • Clean up of metadata must be handled by user
  • 100% Promise API
  • Update mongodb-prebuilt to the newest version
  • Update dependencies and tests
  • Gracefully shutdown Mongodb when execute stop
  • Create recursively databasePath