@kemuscorp/mongodb-crud
A library to handler a CRUD on your MongoDB.
How to install
Using npm
$ npm install @kemuscorp/mongodb-crud
Usage
const { MongoLib } = require('@kemuscorp/mongodb-crud')
// Connecting the client to the database
const database = new MongoLib({
hostname: process.env.HOSTNAME,
port: proccess.env.PORT,
username: process.env.USERNAME,
password: process.env.PASSWORD,
database: process.env.DATABASE
})Take in mind that hostname and database are the only properties required. However, consider using a username, password and changing the default port of your MongoDB database in production.
Methods
Check out the available methods of MongoLib instance.
Method getAll(collection, query)
The method getAll returns a promise with all data of a collection. This method is based on the find method of MongoDB collection method: db.collection.find()
Example
database.getAll('users', { email })
.then(users => console.log(users))
.catch(error => console.error(error))
Method get(collection, id)
The method get returns a promise with the data of a collection based on an ID. This method is based on the findOne method of MongoDB collection method: db.collection.findOne()
Example
database.get('users', '60de157106ce8c61cb76c6f9')
.then(user => console.log(user))
.catch(error => console.error(error))
Method create(collection, data)
The method create returns a promise with the full document created on the collection based on the data you passed. This method is based on the findOne method of MongoDB collection method: db.collection.findOne()
Example
database.create('users', { email: 'user@labs.kemuscorp.com', password: 'averystrongpassword' })
.then(id => console.log(id))
.catch(error => console.error(error))
Method update(collection, id, data)
The method update returns a promise with the document updated on the collection based on the id and data you passed. This method is based on the updateOne method of MongoDB collection method: db.collection.updateOne()
Example
database.replace('users', '60de157106ce8c61cb76c6f9', { email: 'newemail@kemuscorp.com' })
.then(user => console.log(user))
.catch(error => console.error(error))
Method replace(collection, id, data)
The method replace returns a promise with the document replaced on the collection based on the id and data you passed. This method is based on the replaceOne method of MongoDB collection method: db.collection.replaceOne()
Example
database.update('users', '60de157106ce8c61cb76c6f9', { email: 'newemail@kemuscorp.com' })
.then(user => console.log(user))
.catch(error => console.error(error))
Method delete(collection, id)
The method delete returns a promise with the document's id deleted. This method is based on the deleteOne method of MongoDB collection method: db.collection.deleteOne()
Example
database.delete('users', '60de157106ce8c61cb76c6f9')
.then(id => console.log(id))
.catch(error => console.error(error))