brave/monk

Name: monk

Owner: Brave Software

Description: The wise MongoDB API

Forked from: Automattic/monk

Created: 2016-08-09 16:58:57.0

Updated: 2017-04-07 03:34:10.0

Pushed: 2017-04-07 03:35:27.0

Homepage: null

Size: 842

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

monk

Monk is a tiny layer that provides simple yet substantial usability improvements for MongoDB usage within Node.JS.

note: monk 2.x drop the support for node < 0.12. If you are still using an earlier version, stick to monk 1.x

t db = require('monk')('localhost/mydb')
t users = db.get('users')

s.index('name last')
s.insert({ name: 'Tobi', bigdata: {} })
s.find({ name: 'Loki' }, '-bigdata').then(function () {
 exclude bigdata field

s.find({}, {sort: {name: 1}}).then(function () {
 sorted by name field

s.remove({ name: 'Loki' })

lose()

Features

• Command buffering. You can start querying right away.
• Promises built-in for all queries. Easy interoperability with modules.
• Easy connections / configuration
• Well-designed signatures
• Improvements to the MongoDB APIs (eg: findAndModify supports the update signature style)
• Auto-casting of _id in queries
• Allows to set global options or collection-level options for queries. (eg: safe is true by default for all queries)

How to use

Documentation

License

(The MIT License)

Copyright (c) 2012 Guillermo Rauch <guillermo@learnboost.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.