-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathOpQueryOptions.html
25 lines (25 loc) · 51.6 KB
/
OpQueryOptions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OpQueryOptions | mongodb</title><meta name="description" content="Documentation for mongodb"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mongodb</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="OpQueryOptions.html">OpQueryOptions</a></li></ul><h1>Interface OpQueryOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="CommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOptions</a><ul class="tsd-hierarchy"><li><span class="target">OpQueryOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#_kFullResult_" class="tsd-kind-icon">[k<wbr/>Full<wbr/>Result]</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#documentsReturnedIn" class="tsd-kind-icon">documents<wbr/>Returned<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#enableUtf8Validation" class="tsd-kind-icon">enable<wbr/>Utf8<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#exhaustAllowed" class="tsd-kind-icon">exhaust<wbr/>Allowed</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#maxBsonSize" class="tsd-kind-icon">max<wbr/>Bson<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#monitoring" class="tsd-kind-icon">monitoring</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#moreToCome" class="tsd-kind-icon">more<wbr/>To<wbr/>Come</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#numberToReturn" class="tsd-kind-icon">number<wbr/>To<wbr/>Return</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#numberToSkip" class="tsd-kind-icon">number<wbr/>To<wbr/>Skip</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#pre32Limit" class="tsd-kind-icon">pre32<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteBuffers" class="tsd-kind-icon">promote<wbr/>Buffers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteLongs" class="tsd-kind-icon">promote<wbr/>Longs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteValues" class="tsd-kind-icon">promote<wbr/>Values</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#requestId" class="tsd-kind-icon">request<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#returnFieldSelector" class="tsd-kind-icon">return<wbr/>Field<wbr/>Selector</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#secondaryOk" class="tsd-kind-icon">secondary<wbr/>Ok</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#socketTimeoutMS" class="tsd-kind-icon">socket<wbr/>TimeoutMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#willRetryWrite" class="tsd-kind-icon">will<wbr/>Retry<wbr/>Write</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="_kFullResult_" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> [k<wbr/>Full<wbr/>Result]<a href="#_kFullResult_" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">[k<wbr/>Full<wbr/>Result]<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#_kFullResult_">[kFullResult]</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L104">src/cmap/connection.ts:104</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="bsonRegExp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> bson<wbr/>Reg<wbr/>Exp<a href="#bsonRegExp" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#bsonRegExp">bsonRegExp</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:338</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>return BSON regular expressions as BSONRegExp instances.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="checkKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Keys<a href="#checkKeys" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#checkKeys">checkKeys</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L43">src/cmap/commands.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>the serializer will check if keys are valid.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="command" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#command">command</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L98">src/cmap/connection.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="documentsReturnedIn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> documents<wbr/>Returned<wbr/>In<a href="#documentsReturnedIn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">documents<wbr/>Returned<wbr/>In<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#documentsReturnedIn">documentsReturnedIn</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L35">src/cmap/commands.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="enableUtf8Validation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Utf8<wbr/>Validation<a href="#enableUtf8Validation" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Utf8<wbr/>Validation<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#enableUtf8Validation">enableUtf8Validation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/bson.ts#L61">src/bson.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Enable utf8 validation when deserializing BSON documents. Defaults to true.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="exhaustAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> exhaust<wbr/>Allowed<a href="#exhaustAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">exhaust<wbr/>Allowed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L48">src/cmap/commands.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="fieldsAsRaw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> fields<wbr/>As<wbr/>Raw<a href="#fieldsAsRaw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">fields<wbr/>As<wbr/>Raw<span class="tsd-signature-symbol">?:</span> <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#fieldsAsRaw">fieldsAsRaw</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:336</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>allow to specify if there what fields we wish to return as unserialized raw buffer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="ignoreUndefined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr/>Undefined<a href="#ignoreUndefined" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Undefined<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#ignoreUndefined">ignoreUndefined</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L41">src/cmap/commands.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>serialize will not emit undefined fields <strong>(default:true)</strong></p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxBsonSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Bson<wbr/>Size<a href="#maxBsonSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Bson<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L42">src/cmap/commands.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="monitoring" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> monitoring<a href="#monitoring" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">monitoring<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#monitoring">monitoring</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L103">src/cmap/connection.ts:103</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="moreToCome" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> more<wbr/>To<wbr/>Come<a href="#moreToCome" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">more<wbr/>To<wbr/>Come<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L47">src/cmap/commands.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="noResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr/>Response<a href="#noResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Response<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#noResponse">noResponse</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L109">src/cmap/connection.ts:109</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="numberToReturn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>To<wbr/>Return<a href="#numberToReturn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>To<wbr/>Return<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L37">src/cmap/commands.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="numberToSkip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>To<wbr/>Skip<a href="#numberToSkip" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>To<wbr/>Skip<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L36">src/cmap/commands.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="omitReadPreference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> omit<wbr/>Read<wbr/>Preference<a href="#omitReadPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">omit<wbr/>Read<wbr/>Preference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#omitReadPreference">omitReadPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L110">src/cmap/connection.ts:110</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pre32Limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> pre32<wbr/>Limit<a href="#pre32Limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pre32<wbr/>Limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L39">src/cmap/commands.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="promoteBuffers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Buffers<a href="#promoteBuffers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Buffers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#promoteBuffers">promoteBuffers</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:332</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing a Binary will return it as a node.js Buffer instance.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="promoteLongs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Longs<a href="#promoteLongs" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Longs<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#promoteLongs">promoteLongs</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:330</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing a Long will fit it into a Number if it's smaller than 53 bits</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="promoteValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Values<a href="#promoteValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#promoteValues">promoteValues</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:334</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing will promote BSON values to their Node.js closest equivalent types.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> raw<a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#raw">raw</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L102">src/cmap/connection.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return BSON filled buffers from operations</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="readPreference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> read<wbr/>Preference<a href="#readPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">read<wbr/>Preference<span class="tsd-signature-symbol">?:</span> <a href="../classes/ReadPreference.html" class="tsd-signature-type" data-tsd-kind="Class">ReadPreference</a></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#readPreference">readPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L49">src/cmap/commands.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify read preference if command supports it</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="requestId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr/>Id<a href="#requestId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">request<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L46">src/cmap/commands.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="returnFieldSelector" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> return<wbr/>Field<wbr/>Selector<a href="#returnFieldSelector" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">return<wbr/>Field<wbr/>Selector<span class="tsd-signature-symbol">?:</span> <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L38">src/cmap/commands.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="secondaryOk" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> secondary<wbr/>Ok<a href="#secondaryOk" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">secondary<wbr/>Ok<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#secondaryOk">secondaryOk</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L44">src/cmap/commands.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="serializeFunctions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> serialize<wbr/>Functions<a href="#serializeFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">serialize<wbr/>Functions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#serializeFunctions">serializeFunctions</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L40">src/cmap/commands.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>serialize the javascript functions <strong>(default:false)</strong>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="session" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> session<a href="#session" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">?:</span> <a href="../classes/ClientSession.html" class="tsd-signature-type" data-tsd-kind="Class">ClientSession</a></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#session">session</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L34">src/cmap/commands.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Session to use for the operation</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="socketTimeoutMS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> socket<wbr/>TimeoutMS<a href="#socketTimeoutMS" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">socket<wbr/>TimeoutMS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#socketTimeoutMS">socketTimeoutMS</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/commands.ts#L33">src/cmap/commands.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="willRetryWrite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> will<wbr/>Retry<wbr/>Write<a href="#willRetryWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">will<wbr/>Retry<wbr/>Write<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#willRetryWrite">willRetryWrite</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L113">src/cmap/connection.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="writeConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> write<wbr/>Concern<a href="#writeConcern" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">write<wbr/>Concern<span class="tsd-signature-symbol">?:</span> <a href="WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="../classes/WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOptions.html">CommandOptions</a>.<a href="CommandOptions.html#writeConcern">writeConcern</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b578d89/src/cmap/connection.ts#L116">src/cmap/connection.ts:116</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="OpQueryOptions.html" class="tsd-kind-icon">Op<wbr/>Query<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#_kFullResult_" class="tsd-kind-icon">[k<wbr/>Full<wbr/>Result]</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#documentsReturnedIn" class="tsd-kind-icon">documents<wbr/>Returned<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#enableUtf8Validation" class="tsd-kind-icon">enable<wbr/>Utf8<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#exhaustAllowed" class="tsd-kind-icon">exhaust<wbr/>Allowed</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#maxBsonSize" class="tsd-kind-icon">max<wbr/>Bson<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#monitoring" class="tsd-kind-icon">monitoring</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#moreToCome" class="tsd-kind-icon">more<wbr/>To<wbr/>Come</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#numberToReturn" class="tsd-kind-icon">number<wbr/>To<wbr/>Return</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#numberToSkip" class="tsd-kind-icon">number<wbr/>To<wbr/>Skip</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#pre32Limit" class="tsd-kind-icon">pre32<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteBuffers" class="tsd-kind-icon">promote<wbr/>Buffers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteLongs" class="tsd-kind-icon">promote<wbr/>Longs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="OpQueryOptions.html#promoteValues" class="tsd-kind-icon">promote<wbr/>Values</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#requestId" class="tsd-kind-icon">request<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpQueryOptions.html#returnFieldSelector" class="tsd-kind-icon">return<wbr/>Field<wbr/>Selector</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#secondaryOk" class="tsd-kind-icon">secondary<wbr/>Ok</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OpQueryOptions.html#socketTimeoutMS" class="tsd-kind-icon">socket<wbr/>TimeoutMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#willRetryWrite" class="tsd-kind-icon">will<wbr/>Retry<wbr/>Write</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OpQueryOptions.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>