• Public
  • Public/Protected
  • All

Interface MapReduceOptions<TKey, TValue>

Type parameters




authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

bypassDocumentValidation?: boolean

Allow driver to bypass schema validation in MongoDB 3.2 or higher.

bypassPinningCheck?: boolean
checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions


comment?: string | Document

A user-provided comment to attach to this command

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Specifies the verbosity mode for the explain output.

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.

finalize?: string | FinalizeFunction<TKey, TValue>

Finalize function.

fullResponse?: boolean

This option does nothing

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

jsMode?: boolean

It is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X.

keeptemp?: boolean

Keep temporary data.

limit?: number

Number of objects to return from collection.

maxTimeMS?: number
noResponse?: boolean
omitReadPreference?: boolean
out?: "inline" | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string }

Sets the output target for the map reduce job.

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

query?: Document

Query filter object.

raw?: boolean

Return BSON filled buffers from operations

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

retryWrites?: boolean

Should retry failed writes

scope?: Document

Can pass in variables that can be access from map/reduce/finalize.

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

sort?: Sort

Sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces.

verbose?: boolean

Provide statistics on job execution time.

willRetryWrites?: boolean

Write Concern as an object

Generated using TypeDoc