Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mono-js/mongodb-utils
MongoDB utils library for Node.js
https://github.com/mono-js/mongodb-utils
mongodb nodejs npm-module utils
Last synced: 6 days ago
JSON representation
MongoDB utils library for Node.js
- Host: GitHub
- URL: https://github.com/mono-js/mongodb-utils
- Owner: mono-js
- License: mit
- Created: 2017-10-04T09:22:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T23:28:05.000Z (about 6 years ago)
- Last Synced: 2024-10-08T18:12:01.684Z (about 1 month ago)
- Topics: mongodb, nodejs, npm-module, utils
- Language: JavaScript
- Homepage:
- Size: 180 KB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> MongoDB utils for Node.js
[](https://www.npmjs.com/package/mongodb-utils)
[](https://travis-ci.org/terrajs/mongodb-utils)
[](https://codecov.io/gh/terrajs/mongodb-utils)
[](https://github.com/terrajs/mongodb-utils/blob/master/LICENSE)
## Installation
```bash
npm install --save mongodb-utils
```
## Usage
MongoDB utils overide the `collection` class by adding an `utils` object that will expose all the MongoDB utils methods:
```js
const mongoUtils = require('mongodb-utils')
const collection = mongoUtils(db.collection('users'))
// We can now access to mongodb-utils method from .utils
const user = await collection.utils.get({ username: 'terrajs' })
```
## Methods
- [get](#get)
- [create](#create)
- [update](#update)
- [upsert](#upsert)
- [remove](#remove)
- [find](#find)
### get
```js
get(query = { key: value } || string || ObjectID, [fields]): Promise
```
Return a document that match the specific identifier (`_id` by default) or the query:
```js
// Get the document that match the query { _id: ObjectID('59c0de2dfe8fa448605b1d89') }
collection.utils.get('59c0de2dfe8fa448605b1d89')
// Get the document that match the query { username: 'terrajs' }
collection.utils.get({ username: 'terrajs' })
// Get the document that match the query & return only its _id
collection.utils.get({ username: 'terrajs' }, { _id: 1 })
// Get the document that match the query & return only its _id (works with array too)
collection.utils.get({ username: 'terrajs' }, ['_id'])
```
### create
```js
create(doc: object): Promise
```
Insert a document into the collection and add `createdAt` and `updatedAt` properties:
```js
// Add a document into the collection and return the created document
const user = await collection.utils.create({ username: 'terrajs' })
```
### update
```js
update(query = { key: value } || string || ObjectID, doc: object): Promise
```
Update a specific document and update the `updatedAt` value
```js
// Update the document that match the query { _id: ObjectID('59c0de2dfe8fa448605b1d89') } and update its username
await collection.utils.update('59c0de2dfe8fa448605b1d89', { username: 'terrajs2' })
// Update the document that match the query { username: 'terrajs2' } and update its username
await collection.utils.update({ username: 'terrajs2' }, { username: 'terrajs' })
```
### upsert
```js
upsert(query = { key: value } || string || ObjectID, doc: object): Promise
```
Update or create a document if not exist
Add the `createdAt` if document not exist
```js
// Update the document that match the query { _id: ObjectID('59c0de2dfe8fa448605b1d89') } and update its username or create it if not exist
await collection.utils.upsert('59c0de2dfe8fa448605b1d89', { username: 'terrajs2' })
// Update the document that match the query { username: 'terrajs2' } and update its username OR create it if not found
await collection.utils.upsert({ username: 'terrajs2' }, { username: 'terrajs' })
```
### remove
```js
remove(query = { key: value } || string || ObjectID): Promise
```
Remove a document that match the specific identifier (`_id` by default) or the query:
```js
// Remove the document that match the query { _id: ObjectID('59c0de2dfe8fa448605b1d89') }
const result = collection.utils.remove('59c0de2dfe8fa448605b1d89')
// Remove the document that match the query { username: 'test' }
collection.utils.remove({ username: 'test' })
```
### find
```js
find(query = { key: value } || string || ObjectID, [options = { fields: ..., limit: ..., offset: ..., sort: ... }]): cursor
```
The find method return a mongo cursor from a specific query and options.
Options:
- `fields`: Array of keys (`['username', ...]`) to return **OR** a MongoDB projection (`{ field1: 1, ... }`), default: `{}`
- `limit`: Nb of docs to return, no limit by default
- `offset`: Nb of docs to skpi, default: `0`
- `sort`: Sort criteria (same as `sort` method from mongo cursor), default: `{}`
```js
// Find documents that matches the query { username: new RegExp(/^test/g) }, options with { username: 1, createdAt: 1 } projection and limit at 10 elements
const users = await userCollection.mono.find({
username: new RegExp(/^test/g)
}, {
fields: ['username', 'createdAt'],
limit: 10
}).toArray()
```