-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathAggregateOptions.html
67 lines (67 loc) · 61.4 KB
/
AggregateOptions.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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AggregateOptions | 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="AggregateOptions.html">AggregateOptions</a></li></ul><h1>Interface AggregateOptions</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="CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><ul class="tsd-hierarchy"><li><span class="target">AggregateOptions</span><ul class="tsd-hierarchy"><li><a href="AggregationCursorOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregationCursorOptions</a></li><li><a href="CountDocumentsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountDocumentsOptions</a></li></ul></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"><a href="AggregateOptions.html#allowDiskUse" class="tsd-kind-icon">allow<wbr/>Disk<wbr/>Use</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#authdb" class="tsd-kind-icon">authdb</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#batchSize" class="tsd-kind-icon">batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#bypassDocumentValidation" class="tsd-kind-icon">bypass<wbr/>Document<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#comment" class="tsd-kind-icon">comment</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#cursor" class="tsd-kind-icon">cursor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#enableUtf8Validation" class="tsd-kind-icon">enable<wbr/>Utf8<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#explain" class="tsd-kind-icon">explain</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#let" class="tsd-kind-icon">let</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#maxAwaitTimeMS" class="tsd-kind-icon">max<wbr/>Await<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#maxTimeMS" class="tsd-kind-icon">max<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#out" class="tsd-kind-icon">out</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.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="AggregateOptions.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="AggregateOptions.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="AggregateOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#retryWrites" class="tsd-kind-icon">retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#useBigInt64" class="tsd-kind-icon">use<wbr/>Big<wbr/>Int64</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.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="AggregateOptions.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"><a id="allowDiskUse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr/>Disk<wbr/>Use<a href="#allowDiskUse" 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">allow<wbr/>Disk<wbr/>Use<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/v5.3.0/src/operations/aggregate.ts#L16">src/operations/aggregate.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="authdb" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> authdb<a href="#authdb" 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">authdb<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#authdb">authdb</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L57">src/operations/command.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="batchSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr/>Size<a href="#batchSize" 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">batch<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/v5.3.0/src/operations/aggregate.ts#L18">src/operations/aggregate.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The number of documents to return per batch. See <a href="https://www.mongodb.com/docs/manual/reference/command/aggregate">aggregation documentation</a>.</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="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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#bsonRegExp">bsonRegExp</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:430</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"><a id="bypassDocumentValidation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> bypass<wbr/>Document<wbr/>Validation<a href="#bypassDocumentValidation" 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">bypass<wbr/>Document<wbr/>Validation<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/v5.3.0/src/operations/aggregate.ts#L20">src/operations/aggregate.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Allow driver to bypass schema validation in MongoDB 3.2 or higher.</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="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>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#checkKeys">checkKeys</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:1053</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-overwrite"><a id="collation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> collation<a href="#collation" 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">collation<span class="tsd-signature-symbol">?:</span> <a href="CollationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollationOptions</a></div><aside class="tsd-sources"><p>Overrides <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#collation">collation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/aggregate.ts#L28">src/operations/aggregate.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify collation.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="comment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> comment<a href="#comment" 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">comment<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#comment">comment</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L51">src/operations/command.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Comment to apply to the operation.</p>
</div><div><p>In server versions pre-4.4, 'comment' must be string. A server
error will be thrown if any other type is provided.</p>
<p>In server versions 4.4 and above, 'comment' can be any valid BSON type.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="cursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cursor<a href="#cursor" 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">cursor<span class="tsd-signature-symbol">?:</span> <a href="BSON.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/v5.3.0/src/operations/aggregate.ts#L22">src/operations/aggregate.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dbName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> db<wbr/>Name<a href="#dbName" 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">db<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#dbName">dbName</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L56">src/operations/command.ts:56</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#enableUtf8Validation">enableUtf8Validation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/bson.ts#L63">src/bson.ts:63</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 tsd-is-inherited"><a id="explain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> explain<a href="#explain" 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">explain<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ExplainVerbosityLike" class="tsd-signature-type" data-tsd-kind="Type alias">ExplainVerbosityLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#explain">explain</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/explain.ts#L25">src/explain.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies the verbosity mode for the explain output.</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="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="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#fieldsAsRaw">fieldsAsRaw</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:428</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"><a id="hint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> hint<a href="#hint" 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">hint<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/aggregate.ts#L30">src/operations/aggregate.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add an index selection hint to an aggregation command</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="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>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#ignoreUndefined">ignoreUndefined</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:1057</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="let" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> let<a href="#let" 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">let<span class="tsd-signature-symbol">?:</span> <a href="BSON.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/v5.3.0/src/operations/aggregate.ts#L32">src/operations/aggregate.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxAwaitTimeMS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Await<wbr/>TimeMS<a href="#maxAwaitTimeMS" 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/>Await<wbr/>TimeMS<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/v5.3.0/src/operations/aggregate.ts#L26">src/operations/aggregate.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="maxTimeMS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>TimeMS<a href="#maxTimeMS" 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/>TimeMS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#maxTimeMS">maxTimeMS</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/aggregate.ts#L24">src/operations/aggregate.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.</p>
</div></div></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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#noResponse">noResponse</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L58">src/operations/command.ts:58</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#omitReadPreference">omitReadPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/operation.ts#L37">src/operations/operation.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="out" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<a href="#out" 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">out<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/aggregate.ts#L34">src/operations/aggregate.ts:34</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteBuffers">promoteBuffers</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:424</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteLongs">promoteLongs</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:422</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteValues">promoteValues</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:426</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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#raw">raw</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/bson.ts#L60">src/bson.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Enabling the raw option will return a <a href="https://nodejs.org/api/buffer.html">Node.js Buffer</a>
which is allocated using <a href="https://nodejs.org/api/buffer.html#static-method-bufferallocunsafesize">allocUnsafe API</a>.
See this section from the <a href="https://nodejs.org/api/buffer.html#what-makes-bufferallocunsafe-and-bufferallocunsafeslow-unsafe">Node.js Docs here</a>
for more detail about what "unsafe" refers to in this context.
If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate
your own buffer and clone the contents:</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">raw</span><span class="hl-0"> = </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">findOne</span><span class="hl-0">({}, { </span><span class="hl-6">raw:</span><span class="hl-0"> </span><span class="hl-3">true</span><span class="hl-0"> });</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myBuffer</span><span class="hl-0"> = </span><span class="hl-6">Buffer</span><span class="hl-0">.</span><span class="hl-2">alloc</span><span class="hl-0">(</span><span class="hl-6">raw</span><span class="hl-0">.</span><span class="hl-6">byteLength</span><span class="hl-0">);</span><br/><span class="hl-6">myBuffer</span><span class="hl-0">.</span><span class="hl-2">set</span><span class="hl-0">(</span><span class="hl-6">raw</span><span class="hl-0">, </span><span class="hl-8">0</span><span class="hl-0">);</span><br/><span class="hl-1">// Only save and use `myBuffer` beyond this point</span>
</code></pre>
</dd><dt>remarks</dt><dd><p>Please note there is a known limitation where this option cannot be used at the MongoClient level (see <a href="https://jira.mongodb.org/browse/NODE-3946">NODE-3946</a>).
It does correctly work at <code>Db</code>, <code>Collection</code>, and per operation the same as other BSON options work.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="readConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> read<wbr/>Concern<a href="#readConcern" 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/>Concern<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ReadConcernLike" class="tsd-signature-type" data-tsd-kind="Type alias">ReadConcernLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#readConcern">readConcern</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L39">src/operations/command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><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="../modules.html#ReadPreferenceLike" class="tsd-signature-type" data-tsd-kind="Type alias">ReadPreferenceLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#readPreference">readPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/operation.ts#L33">src/operations/operation.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="retryWrites" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Writes<a href="#retryWrites" 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">retry<wbr/>Writes<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#retryWrites">retryWrites</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/command.ts#L53">src/operations/command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Should retry failed writes</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="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>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#serializeFunctions">serializeFunctions</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:1055</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-inherited"><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>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#session">session</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/operation.ts#L29">src/operations/operation.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify ClientSession for this command</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="useBigInt64" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Big<wbr/>Int64<a href="#useBigInt64" 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">use<wbr/>Big<wbr/>Int64<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#useBigInt64">useBigInt64</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:420</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing a Long will return as a BigInt.</p>
</div></div></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="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#willRetryWrite">willRetryWrite</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/operation.ts#L30">src/operations/operation.ts:30</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="../classes/WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcernSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernSettings</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#writeConcern">writeConcern</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/write_concern.ts#L7">src/write_concern.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Write Concern as an object</p>
</div></div></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><li class="label tsd-is-external"><span>Internals</span></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="../modules/BSON.html">BSON</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AggregateOptions.html" class="tsd-kind-icon">Aggregate<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#allowDiskUse" class="tsd-kind-icon">allow<wbr/>Disk<wbr/>Use</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#authdb" class="tsd-kind-icon">authdb</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#batchSize" class="tsd-kind-icon">batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#bypassDocumentValidation" class="tsd-kind-icon">bypass<wbr/>Document<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#comment" class="tsd-kind-icon">comment</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#cursor" class="tsd-kind-icon">cursor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#enableUtf8Validation" class="tsd-kind-icon">enable<wbr/>Utf8<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#explain" class="tsd-kind-icon">explain</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#let" class="tsd-kind-icon">let</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#maxAwaitTimeMS" class="tsd-kind-icon">max<wbr/>Await<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#maxTimeMS" class="tsd-kind-icon">max<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#out" class="tsd-kind-icon">out</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.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="AggregateOptions.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="AggregateOptions.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="AggregateOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#retryWrites" class="tsd-kind-icon">retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#useBigInt64" class="tsd-kind-icon">use<wbr/>Big<wbr/>Int64</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.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="AggregateOptions.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-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-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></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><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></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>