style(model): add "ReadPreference" as possible for "opts.readPreference" to "Model.mapReduce"

hasezoey · hasezoey · commit bb19246d7ec1 · 2022-07-15T11:49:51.000+02:00
also adds a description
diff --git a/lib/model.js b/lib/model.js
@@ -4035,7 +4035,7 @@ function _update(model, op, conditions, doc, options, callback) {
  *
  * @param {Object} opts an object specifying map-reduce options
  * @param {Boolean} [opts.verbose=false] provide statistics on job execution time
- * @param {String} [opts.readPreference]
+ * @param {ReadPreference|String} [opts.readPreference] a read-preference string or a read-preference instance
  * @param {Boolean} [opts.jsMode=false] it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X
  * @param {Object} [opts.scope] scope variables exposed to map/reduce/finalize during execution
  * @param {Function} [opts.finalize] finalize function

Original file line number	Diff line number	Diff line change
`@@ -4035,7 +4035,7 @@ function _update(model, op, conditions, doc, options, callback) {`
`4035`	`4035`	`*`
`4036`	`4036`	`* @param {Object} opts an object specifying map-reduce options`
`4037`	`4037`	`* @param {Boolean} [opts.verbose=false] provide statistics on job execution time`
`4038`		`- * @param {String} [opts.readPreference]`
	`4038`	`+ * @param {ReadPreference\|String} [opts.readPreference] a read-preference string or a read-preference instance`
`4039`	`4039`	`* @param {Boolean} [opts.jsMode=false] it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X`
`4040`	`4040`	`* @param {Object} [opts.scope] scope variables exposed to map/reduce/finalize during execution`
`4041`	`4041`	`* @param {Function} [opts.finalize] finalize function`