keyv-mongodb

keyv-mongodb

MongoDB storage adapter for Keyv with support for Mongoose

Installation

mongodb and mongoose are both peerDependecies. Install either one (or both) you'll be using with this package.

yarn add keyv keyv-mongodb mongoose
# or
yarn add keyv keyv-mongodb mongodb

Compatibility

• Support Mongoose >= 6
• Support native MongoDB driver >= 4
• Support Node.js 10-17

Connection to MongoDB

Re-use a Mongoose connection

const mongoose = require('mongoose')

mongoose.connect(connectionOptions)

const keyv = new Keyv({
	store: new KeyvMongoDB({ mongooseConnection: mongoose.connection }),
})

Re-use a native MongoDB driver connection (or a promise)

const keyv = new Keyv({
	store: new KeyvMongoDB({ db: dbInstance }),
})

Or just give a promise...

const keyv = new Keyv({
	store: new KeyvMongoDB({ dbPromise: dbInstancePromise }),
})

Create a new connection from a MongoDB connection string

MongoDB connection strings are the best way to configure a new connection. For advanced usage, more options can be configured with mongoOptions property.

const keyv = new Keyv({
	store: new KeyvMongoDB({ url: 'mongodb://localhost/test-app' }),
})

License

ISC License

Based on work from

• https://github.com/jdesboeufs/connect-mongo
• https://github.com/lukechilds/keyv-mongo