|
35 | 35 | error will be thrown if any other type is provided.</p> |
36 | 36 | <p>In server versions 4.4 and above, 'comment' can be any valid BSON type.</p> |
37 | 37 | </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L135">src/cursor/abstract_cursor.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableUtf8Validation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>enable<wbr/>Utf8<wbr/>Validation</span><a href="#enableUtf8Validation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enable<wbr/>Utf8<wbr/>Validation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable utf8 validation when deserializing BSON documents. Defaults to true.</p> |
38 | | -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#enableUtf8Validation">enableUtf8Validation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/bson.ts#L107">src/bson.ts:107</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fieldsAsRaw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>fields<wbr/>As<wbr/>Raw</span><a href="#fieldsAsRaw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fields<wbr/>As<wbr/>Raw</span><span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type tsd-kind-interface">Document</a></div><div class="tsd-comment tsd-typography"><p>allow to specify if there what fields we wish to return as unserialized raw buffer.</p> |
| 38 | +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#enableUtf8Validation">enableUtf8Validation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/bson.ts#L113">src/bson.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fieldsAsRaw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>fields<wbr/>As<wbr/>Raw</span><a href="#fieldsAsRaw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fields<wbr/>As<wbr/>Raw</span><span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type tsd-kind-interface">Document</a></div><div class="tsd-comment tsd-typography"><p>allow to specify if there what fields we wish to return as unserialized raw buffer.</p> |
39 | 39 | </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Default Value-2" class="tsd-anchor"></a>Default Value<a href="#Default Value-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>null</code></p> |
40 | 40 | </div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#fieldsAsRaw">fieldsAsRaw</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:674</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ignoreUndefined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ignore<wbr/>Undefined</span><a href="#ignoreUndefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignore<wbr/>Undefined</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>serialize will not emit undefined fields |
41 | 41 | note that the driver sets this to <code>false</code></p> |
|
61 | 61 |
|
62 | 62 | <h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><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" target="_blank" class="external">NODE-3946</a>). |
63 | 63 | It does correctly work at <code>Db</code>, <code>Collection</code>, and per operation the same as other BSON options work.</p> |
64 | | -</div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#raw">raw</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/bson.ts#L104">src/bson.ts:104</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="readConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>read<wbr/>Concern</span><a href="#readConcern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Concern</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ReadConcernLike.html" class="tsd-signature-type tsd-kind-type-alias">ReadConcernLike</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L112">src/cursor/abstract_cursor.ts:112</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="readPreference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>read<wbr/>Preference</span><a href="#readPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Preference</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ReadPreferenceLike.html" class="tsd-signature-type tsd-kind-type-alias">ReadPreferenceLike</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L111">src/cursor/abstract_cursor.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="serializeFunctions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>serialize<wbr/>Functions</span><a href="#serializeFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serialize<wbr/>Functions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>serialize the javascript functions</p> |
| 64 | +</div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#raw">raw</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/bson.ts#L110">src/bson.ts:110</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="readConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>read<wbr/>Concern</span><a href="#readConcern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Concern</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ReadConcernLike.html" class="tsd-signature-type tsd-kind-type-alias">ReadConcernLike</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L112">src/cursor/abstract_cursor.ts:112</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="readPreference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>read<wbr/>Preference</span><a href="#readPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Preference</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ReadPreferenceLike.html" class="tsd-signature-type tsd-kind-type-alias">ReadPreferenceLike</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L111">src/cursor/abstract_cursor.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="serializeFunctions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>serialize<wbr/>Functions</span><a href="#serializeFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serialize<wbr/>Functions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>serialize the javascript functions</p> |
65 | 65 | </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Default Value-7" class="tsd-anchor"></a>Default Value<a href="#Default Value-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>false</code></p> |
66 | 66 | </div><aside class="tsd-sources"><p>Inherited from <a href="BSONSerializeOptions.html">BSONSerializeOptions</a>.<a href="BSONSerializeOptions.html#serializeFunctions">serializeFunctions</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:1566</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="session" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>session</span><a href="#session" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">session</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/ClientSession.html" class="tsd-signature-type tsd-kind-class">ClientSession</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L110">src/cursor/abstract_cursor.ts:110</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tailable</span><a href="#tailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tailable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>By default, MongoDB will automatically close a cursor when the |
67 | 67 | client has exhausted all results in the cursor. However, for <a href="https://www.mongodb.com/docs/manual/core/capped-collections" target="_blank" class="external">capped collections</a> |
|
0 commit comments