monastery 2.2.3 → 3.0.0

package/.eslintrc.json

@@ -8,9 +8,11 @@
     "eslint:recommended"
   ],
   "globals": {
+    // jest globals
     "test": true,
     "expect": true,
-    "oid": true
+    "afterAll": true,
+    "beforeAll": true
   },
   "parserOptions": {
     "ecmaFeatures": {
@@ -22,6 +24,13 @@
   "plugins": [],
   "rules": {
     "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+    "comma-dangle": ["error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "never"
+    }],
     "max-len": ["error", { "code": 125, "ignorePattern": "^\\s*<(rect|path|line)\\s" }],
     "no-prototype-builtins": "off",
     "no-unused-vars": ["error", { "args": "none" }],

package/changelog.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [2.2.3](https://github.com/boycce/monastery/compare/2.2.2...2.2.3) (2024-04-28)
+## [3.0.0](https://github.com/boycce/monastery/compare/2.2.2...3.0.0) (2024-04-28)
 
 ### [2.2.2](https://github.com/boycce/monastery/compare/2.2.1...2.2.2) (2024-04-07)
 

package/docs/_config.yml

@@ -1,11 +1,11 @@
 remote_theme: boycce/github-docs
 title: Monastery
-description: A straight forward MongoDB ODM built upon MonkJS
+description: A simple, straightforward MongoDB ODM
 github_url: "https://github.com/boycce/monastery"
 port: 4001
 basedir: "docs"
 
-# Aux links for the naviation.
+# Aux links for the navigation.
 aux_links:
   "Monastery on GitHub":
     - "//github.com/boycce/monastery"

package/docs/definition/index.md

@@ -161,8 +161,7 @@ fieldType: {
   index: 'text'
 
   // You can also pass an object if you need to use mongodb's index options
-  // https://docs.mongodb.com/manual/reference/command/createIndexes/
-  // https://mongodb.github.io/node-mongodb-native/2.1/api/Collection.html#createIndexes
+  // https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#createIndex
   index: { type: 1, ...(any mongodb index option) },
 
 }

package/docs/manager/index.md

@@ -6,26 +6,25 @@ has_children: true
 
 # Manager
 
-Monastery constructor, same as the [monk constructor](https://automattic.github.io/monk/docs/manager/).
+Monastery manager constructor.
 
 ### Arguments
 
-`uri` *(string\|array)*: A [mongo connection string URI](https://docs.mongodb.com/manual/reference/connection-string/). Replica sets can be an array or comma separated.
+`uri` *(string\|array)*: A [mongo connection string URI](https://www.mongodb.com/docs/v5.0/reference/connection-string/). Replica sets can be an array or comma separated.
 
 [`options`] *(object)*:
   - [`hideWarnings=false`] *(boolean)*: hide monastery warnings
   - [`hideErrors=false`] *(boolean)*: hide monastery errors
   - [`defaultObjects=false`] *(boolean)*: when [inserting](../model/insert.html#defaults-example), undefined embedded documents and arrays are defined
   - [`nullObjects=false`] *(boolean)*: embedded documents and arrays can be set to null or an empty string (which gets converted to null). You can override this per field via `nullObject: true`.
+  - [`promise=false`] *(boolean)*: return a promise instead of the manager instance
   - [`timestamps=true`] *(boolean)*: whether to use [`createdAt` and `updatedAt`](../definition), this can be overridden per operation
   - [`useMilliseconds=false`] *(boolean)*: by default the `createdAt` and `updatedAt` fields that get created automatically use unix timestamps in seconds, set this to true to use milliseconds instead.
-  - [`mongo options`](http://mongodb.github.io/node-mongodb-native/3.2/reference/connecting/connection-settings/)...
-
-[`callback`] *(function)*: You may optionally specify a callback which will be called once the connection to the mongo database is opened or throws an error.
+  - [`mongo options`](https://mongodb.github.io/node-mongodb-native/5.9/interfaces/MongoClientOptions.html)...
 
 ### Returns
 
-A monk manager instance with additional Monastery methods, i.e. `model` `models`
+A manager instance.
 
 ### Example
 
@@ -40,16 +39,25 @@ const db = monastery('localhost/mydb,192.168.1.1') // replica set
 ```
 
 ```js
+ // You can wait for the connection (which is not required before calling methods)
 import monastery from 'monastery'
-monastery('localhost/mydb,192.168.1.1').then((db) => {
-  // db is the connected instance of the Manager
-}).catch((err) => {
-  // error connecting to the database
-})
+const db = await monastery('localhost/mydb,192.168.1.1', { promise: true })
 ```
 
+```js
+// You can listen for connection errors using our `catch` hook
+import monastery from 'monastery'
+const db = monastery('localhost/mydb,192.168.1.1').catch(err => {})
+```
+
+### Properties
+
+- `manager.db`: Raw Mongo db instance
+- `manager.client`: Raw Mongo client instance
+
 ### Methods
 
+- `manager.catch(Function)`: Catches connection errors
 - `manager.id(<String|ObjectId>)`: Create or convert a valid MongoDB ObjectId string into an ObjectId
 - `manager.isId(String|ObjectId)`: Checks if the passed variable is a valid MongoDB ObjectId or ObjectId string
 - `manager.model()`: [see model](./model.html)

package/docs/manager/model.md

@@ -19,7 +19,7 @@ A [model](../model) instance, the model instance will also be avaliable at:
 
 ```js
 db.user
-db.model.user
+db.models.user
 ```
 
 ### Example

package/docs/manager/models.md

@@ -13,10 +13,10 @@ Setup model definitions from a folder location
 
 ### Returns
 
-A promise with an array of [model](../model) instances, the model instances will also be avaliable at:
+A promise with an array of [model](../model) instances, the model instances will also be available at:
 ```js
 db.{model-name}
-db.model.{model-name}
+db.models.{model-name}
 ```
 
 ### Example
@@ -36,5 +36,4 @@ export default { // Make sure the model definition is exported as the default
 
 ```js
 await db.models(__dirname + "models")
-db.user.insert()
 ```

package/docs/model/...rawMethods.md

@@ -0,0 +1,289 @@
+---
+title: ...raw methods
+parent: Model
+---
+
+# Raw Methods
+
+These MongoDB collection methods are made available if you need to test or run any method without hooks or Monastery argument/return processing.
+
+These methods can be accessed via the `model._*`.
+
+## Returns
+
+All methods return a promise.
+
+## Methods
+
+  * model.[_aggregate](#model._aggregate)
+  * model.[_bulkWrite](#model._bulkWrite)
+  * model.[_count](#model._count)
+  * model.[_createIndex](#model._createIndex)
+  * model.[_createIndexes](#model._createIndexes)
+  * model.[_distinct](#model._distinct)
+  * model.[_drop](#model._drop)
+  * model.[_dropIndex](#model._dropIndex)
+  * model.[_dropIndexes](#model._dropIndexes)
+  * model.[_find](#model._find)
+  * model.[_findOne](#model._findOne)
+  * model.[_findOneAndDelete](#model._findOneAndDelete)
+  * model.[_findOneAndUpdate](#model._findOneAndUpdate)
+  * model.[_indexes](#model._indexes)
+  * model.[_indexInformation](#model._indexInformation)
+  * model.[_insert](#model._insert)
+  * model.[_remove](#model._remove)
+  * model.[_stats](#model._stats)
+  * model.[_update](#model._update)
+
+### [`model._aggregate`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#aggregate)
+
+  Execute an aggregation framework pipeline against the collection. Arguments: 
+
+  1. `Pipeline` *(array)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users.aggregate([
+    { $project : { author : 1, tags : 1 }},
+    { $unwind : "$tags" },
+    { $group : { _id : { tags : "$tags" }}}
+  ])
+  ```
+
+### [`model._bulkWrite`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#bulkWrite)
+
+  Perform a bulkWrite operation without a fluent API. Arguments:
+
+  1. `Operations` *(array)* - Bulk operations to perform
+  2. `[Options]` *(object)*
+
+  Legal operation types are:
+
+  ```js
+  await users._bulkWrite([
+    { insertOne: { document: { a: 1 } } },
+    { updateOne: { filter: {a:2}, update: {$set: {a:2}}, upsert:true } },
+    { updateMany: { filter: {a:2}, update: {$set: {a:2}}, upsert:true } },
+    { deleteOne: { filter: {c:1} } },
+    { deleteMany: { filter: {c:1} } },
+    { replaceOne: { filter: {c:3}, replacement: {c:4}, upsert:true}}
+  ])
+  ```
+
+### [`model._count`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#count)
+
+  Returns the count of documents that would match a find() query. The method uses collection.countDocuments() in the mongo driver. Arguments:
+
+  1. `[Filter]` *(string|objectId|object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._count({ name: 'foo' })
+  await users._count('id') // a bit useless but consistent with the rest of the API
+  await users._count()
+  ```
+
+  If you need to get a fast order of magnitude of the count of all documents in your collection, you can use the estimate option.
+
+  ```js
+  await users._count({}, { estimate: true }) // Filter is ignored
+  ```
+
+### [`model._createIndex`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#createIndex)
+
+  Creates an index on the db and collection collection. Arguments:
+
+  1. `IndexSpec` *(string|array|object)* - The field name or index specification to create an index for
+  2. `[Options]` *(object)*
+
+  ```js
+  await users.createIndex({ a: 1, b: -1 });
+  // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
+  await users.createIndex([ [c, 1], [d, -1] ]);
+  // Equivalent to { e: 1 }
+  await users.createIndex('e');
+  // Equivalent to { f: 1, g: 1 }
+  await users.createIndex(['f', 'g'])
+  // Equivalent to { h: 1, i: -1 }
+  await users.createIndex([ { h: 1 }, { i: -1 } ]);
+  // Equivalent to { j: 1, k: -1, l: 2d }
+  await users.createIndex(['j', ['k', -1], { l: '2d' }])
+  ```
+
+### [`model._createIndexes`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#createIndexes)
+
+  Creates multiple indexes in the collection. Arguments:
+
+  1. `IndexSpec` *(array<IndexSpec>)*- The field names or index specifications to create an indexes for
+  2. `[Options]` *(object)*
+
+  ```js
+  await users.createIndexes([
+    // Simple index on field fizz
+    { key: { fizz: 1 } }
+    // wildcard index
+    { key: { '$**': 1 } },
+    // named index on darmok and jalad
+    { key: { darmok: 1, jalad: -1 } name: 'tanagra' }
+  ])
+  ```
+
+### [`model._distinct`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#distinct)
+
+  Returns a list of distinct values for the given key across a collection. Arguments:
+
+  1. `Key` *(string)*
+  2. `[Filter]` *(string|objectId|object)*
+  3. `[Options]` *(object)*
+
+  ```js
+  await users._distinct('name')
+  ```
+
+### [`model._drop`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#drop)
+
+  Drops the entire collection. Arguments: `None`
+
+  ```js
+  await users._drop()
+  ```
+
+### [`model._dropIndex`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#dropIndex)
+
+  Drops an index on the collection. Arguments:
+
+  1. `IndexName` *(string)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._dropIndex('name')
+  await users._dropIndex('name.last')
+  ```
+
+### [`model._dropIndexes`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#dropIndexes)
+
+  Drops all indexes from the collection. Arguments: `None`
+
+  ```js
+  await users._dropIndexes()
+  ```
+
+### [`model._find`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#find)
+
+  Finds documents in the collection. Arguments:
+
+  1. `[Filter]` *(string|objectId|object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._find()
+  await users._find({ name: 'John' })
+  await users._find({}, { projection: { name: 1 } }) // only the name field will be selected
+  await users._find({}, { rawCursor: true }) // returns raw mongo cursor
+  await users._find({}, { 
+    stream: ((doc, { close, pause, resume }) => {
+      // the users are streaming here
+      // call `close()` to stop the stream
+    })
+  })
+  ```
+
+### [`model._findOne`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#findOne)
+
+  Fetches the first document that matches the filter. Arguments:
+
+  1. `[Filter]` *(string|objectId|object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._findOne({ name: 'John' })
+  await users._findOne({}, { projection: { name: 1 } }) // only the name field will be selected
+  ```
+
+### [`model._findOneAndDelete`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#findOneAndDelete)
+
+  Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation. Arguments: 
+
+  1. `[Filter]` *(string|objectId|object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._findOneAndDelete({ name: 'John' })
+  ```
+
+### [`model._findOneAndUpdate`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#findOneAndUpdate)
+
+  Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation. Arguments: 
+
+  1. `Filter` *(string|objectId|object)*
+  2. `Update` *(object)*
+  3. `[Options]` *(object)*
+
+  ```js
+  await users._findOneAndUpdate({ name: 'John' }, { $set: { age: 30 } })
+  ```
+
+### [`model._indexInformation`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#indexInformation)
+
+  Retrieves this collections index info. Argument(s):
+
+  1. `[Options]` *(object)* 
+
+  ```js
+  await users._indexInformation()
+  ```
+
+### [`model._indexes`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#indexes)
+
+  Lists all indexes on the collection. Argument(s):
+
+  1. `[Options]` *(object)*
+
+  ```js
+  await users._indexes()
+  ```
+
+### [`model._insert`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#insertMany)
+
+  Inserts one or more documents into the collection. Arguments:
+
+  1. `Doc` *(object|array)* - one or many documents
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._insert({ name: 'John', age: 30 })
+  await users._insert([{ name: 'John', age: 30 }, { name: 'Bill', age: 32 }])
+  ```
+
+### [`model._remove`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#deleteMany)
+
+  Removes one or more document(s) from the collection. Arguments:
+
+  1. `Filter` *(string|objectId|object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._remove({ name: 'John' })
+  ```
+
+### [`model._stats`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#stats)
+
+  Returns statistics about the collection. Arguments:
+
+  1. `[Options]` *(object)*
+
+  ```js
+  await users._stats()
+  ```
+
+### [`model._update`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#updateMany)
+
+  Updates one or more document(s) from the collection. Arguments:
+
+  1. `Filter` *(string|objectId|object)*
+  1. `Update` *(object)*
+  2. `[Options]` *(object)*
+
+  ```js
+  await users._update({ name: 'John' }, { $set: { age: 30 } })
+  ```

package/docs/model/count.md

@@ -0,0 +1,25 @@
+---
+title: count
+parent: Model
+---
+
+# `model.count`
+
+Count document(s) in a collection
+
+### Arguments
+
+`options` *(object)*
+
+- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v5.0/tutorial/query-documents/), or id
+- [[`any mongodb option`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#count)] *(any)*
+
+### Returns
+
+A promise
+
+### Example
+
+```js
+await user.count({ query: { name: "Martin Luther" }}) // 4
+```

package/docs/model/find.md

@@ -5,25 +5,23 @@ parent: Model
 
 # `model.find`
 
-Find document(s) in a collection and call the model hook: `afterFind`
+Find document(s) in a collection, and call the model hook: `afterFind`
 
 ### Arguments
 
 `options` *(object)*
 
-- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v4.4/tutorial/query-documents/), or id
+- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v5.0/tutorial/query-documents/), or id
 - [[`blacklist`](#blacklisting)] *(array\|string\|false)*: augment `definition.findBL`. `false` will remove all blacklisting
 - [`getSignedUrls`] *(boolean)*: get signed urls for all image objects
 - [[`populate`](#populate)] *(array)*
 - [`project`] *(string\|array\|object)*: return only these fields, ignores blacklisting
 - [`sort`] *(string\|array\|object)*: same as the mongodb option, but allows string parsing e.g. 'name', 'name:1'
-- [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#find)] *(any)*
-
-[`callback`] *(function)*: pass instead of return a promise
+- [[`any mongodb option`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#find)] *(any)*
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 
@@ -81,9 +79,7 @@ user.find({ query: {...}, populate: ['myBooks.book'] })
 
 ### Custom Populate Query
 
-If you would like more control you can either use monk's native
-[aggregate](https://automattic.github.io/monk/docs/collection/aggregate.html) function via
-`user._aggregate`, or simply pass a MongoDB lookup object to populate. When passing a lookup object, the
+If you would like more control you can either use Mongo's `aggregate` method via [`model._aggregate`](./...rawMethods), or simply pass a MongoDB lookup object to populate. When passing a lookup object, the
 populated field still needs to be defined in `definition.fields` if you want to call any related hooks,
 and prune any blacklisted fields. See the examples below,
 

package/docs/model/findOne.md

@@ -13,7 +13,7 @@ Same argument signature as [`model.find`](./find).
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 

package/docs/model/findOneAndUpdate.md

@@ -13,7 +13,7 @@ Same argument signatures as [`model.find`](./find) and [`model.update`](./update
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 

package/docs/model/index.md

@@ -8,35 +8,10 @@ has_children: true
 
 Created via [`manager.model`](../manager/model).
 
-#### Monk collection instance operators
+### Properties
 
-Additionally models inherit most of the [monk collection](https://automattic.github.io/monk/docs/collection/) instance operators which are available under `model`.
+You can access the following properties from each model:
 
-  * model.[_aggregate](https://automattic.github.io/monk/docs/collection/aggregate.html)
-  * model.[_bulkWrite](https://automattic.github.io/monk/docs/collection/bulkWrite.html)
-  * model.[_count](https://automattic.github.io/monk/docs/collection/count.html)
-  * model.[_distinct](https://automattic.github.io/monk/docs/collection/distinct.html)
-  * model.[_drop](https://automattic.github.io/monk/docs/collection/drop.html)
-  * model.[_dropIndex](https://automattic.github.io/monk/docs/collection/dropIndex.html)
-  * model.[_dropIndexes](https://automattic.github.io/monk/docs/collection/dropIndexes.html)
-  * model.[_ensureIndex](https://automattic.github.io/monk/docs/collection/ensureIndex.html)
-  * model.[_find](https://automattic.github.io/monk/docs/collection/find.html)
-  * model.[_findOne](https://automattic.github.io/monk/docs/collection/findOne.html)
-  * model.[_findOneAndDelete](https://automattic.github.io/monk/docs/collection/findOneAndDelete.html)
-  * model.[_findOneAndUpdate](https://automattic.github.io/monk/docs/collection/findOneAndUpdate.html)
-  * model.[_geoHaystackSearch](https://automattic.github.io/monk/docs/collection/geoHaystackSearch.html)
-  * model.[_geoNear](https://automattic.github.io/monk/docs/collection/geoNear.html)
-  * model.[_group](https://automattic.github.io/monk/docs/collection/group.html)
-  * model.[_indexes](https://automattic.github.io/monk/docs/collection/indexes.html)
-  * model.[_insert](https://automattic.github.io/monk/docs/collection/insert.html)
-  * model.[_mapReduce](https://automattic.github.io/monk/docs/collection/mapReduce.html)
-  * model.[_remove](https://automattic.github.io/monk/docs/collection/remove.html)
-  * model.[_stats](https://automattic.github.io/monk/docs/collection/stats.html)
-  * model.[_update](https://automattic.github.io/monk/docs/collection/update.html)
-
-#### Monk collection
-
-If you wish to access the raw monk collection, you can do so via:
-```js
-model._collection
-```
+- `model.manager`: Monastery manager instance
+- `model.collection`: Monastery collection instance
+- `model.collection.col`: Raw Mongo collection

package/docs/model/insert.md

@@ -16,19 +16,17 @@ Validate and insert document(s) in a collection and calls model hooks: `beforeIn
 - [`project`] *(string\|array\|object)*: project these fields, ignores blacklisting
 - [`skipValidation`] (string\|array\|boolean): skip validation for these field name(s), or `true` for all fields
 - [`timestamps`] *(boolean)*: whether `createdAt` and `updatedAt` are automatically inserted, defaults to `manager.timestamps`
-- [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#insert)] *(any)*
-
-[`callback`] *(function)*: pass instead of return a promise
+- [[`any mongodb option`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#insertMany)] *(any)*
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 
 ```js
-user.insert({ data: { name: 'Martin Luther' }})
-user.insert({ data: [{ name: 'Martin Luther' }, { name: 'Bruce Lee' }]})
+await user.insert({ data: { name: 'Martin Luther' }})
+await user.insert({ data: [{ name: 'Martin Luther' }, { name: 'Bruce Lee' }]})
 ```
 
 ### Blacklisting

package/docs/model/remove.md

@@ -11,19 +11,17 @@ Remove document(s) in a collection and calls model hooks: `beforeRemove`,  `afte
 
 `options` *(object)*
 
-- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v4.4/tutorial/query-documents/), or id
+- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v5.0/tutorial/query-documents/), or id
 - [`sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
 - [`multi`] *(boolean)*: set to false remove only the first document that match the query criteria
-- [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#remove)] *(any)*
-
-[`callback`] *(function)*: pass instead of return a promise
+- [[`any mongodb option`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#deleteMany)] *(any)*
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 
 ```js
-user.remove({ query: { name: "Martin Luther" }})
+await user.remove({ query: { name: "Martin Luther" }})
 ```

package/docs/model/update.md

@@ -11,25 +11,23 @@ Update document(s) in a collection and calls model hooks: `beforeUpdate`,  `afte
 
 `options` *(object)*
 
-- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v4.4/tutorial/query-documents/), or id
+- `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v5.0/tutorial/query-documents/), or id
 - [`data`](#data) *(object)* - data that's validated against the model fields (always wrapped in `{ $set: .. }`)
 - [[`blacklist`](#blacklisting)]*(array\|string\|false)*: augment `definition.updateBL`. `false` will remove all blacklisting
 - [`project`] *(string\|array\|object)*: project these fields, ignores blacklisting
 - [`skipValidation`] (string\|array\|boolean): skip validation for these field name(s), or `true` for all fields
 - [`sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
 - [`timestamps`] *(boolean)*: whether `updatedAt` is automatically updated, defaults to the `manager.timestamps` value
-- [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#update)] *(any)*
-
-[`callback`] *(function)*: pass instead of return a promise
+- [[`any mongodb option`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#updateMany)] *(any)*
 
 ### Returns
 
-A promise if no callback is passed in.
+A promise
 
 ### Example
 
 ```js
-user.update({ query: { name: 'foo' }, data: { name: 'bar' }})
+await user.update({ query: { name: 'foo' }, data: { name: 'bar' }})
 ```
 
 ### Data