Mongopath MongoDB Client
The client uses the model/command
syntax. All commands return promises (async functions), so remember to use await. Ids are stored as strings unless overridden.
Each function takes query, values and options arguments depending on the command. Most mongodb options and query parameters are supported.
Install
npm i mongopath
Usage
/* Connect to database */const connection = /* Default options */const db = await /* Insert document */// Returns the inserted id: { _id: '507f191e810c19729de860ea' }// Takes only 1 argument: queryconst result = await name: 'hello' /* Update document (updates multiple if query matches) */// Returns the number of updated documents: { n: 1 }// Takes 2 arguments: query, valuesconst result = await _id: '507f191e810c19729de860ea' name: 'bye' /* Remove document (removes multiple if query matches) */// Returns the number of removed documents: { n: 1 }// Takes 1 argument: queryconst result = await _id: '507f191e810c19729de860ea' /* Find document */// Returns an array of matching documents// Takes 2 arguments: query, options // Find allconst result = await // Find all with name 'bye'const result = await name: 'bye' // Find with sorting on 'name' field descending, use 1 for ascendingconst result = await {} sort: name: -1 // Find only 2const result = await {} limit: 2 // Find but skip 2const result = await {} skip: 2 // Find all but don't include the 'name' field in the resultconst result = await {} fields: name: false // Find all with 'level' field greater than 5const result = await level: $gt: 5 // All of the mongodb query operators work:// https://docs.mongodb.com/manual/reference/operator/query/ /* Get document */// Returns the first matching document// Takes 2 arguments: query, optionsconst result = await name: 'bye' /* Count documents */// Returns the count of the matching query// Takes 2 arguments: query, optionsconst result = await name: 'bye'
The source code and tests contain more examples of use.
MIT Licensed. Enjoy!