Skip to content

Commit f506b6a

Browse files
docs: generate docs from latest main [skip-ci] (#3854)
1 parent 84959ee commit f506b6a

File tree

424 files changed

+7937
-3345
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

424 files changed

+7937
-3345
lines changed

docs/Next/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Next/classes/AbstractCursor.html

Lines changed: 207 additions & 78 deletions
Large diffs are not rendered by default.

docs/Next/classes/Admin.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -626,6 +626,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
626626
<li><a href="../types/SchemaMember.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Schema<wbr/>Member</span></a></li>
627627
<li><a href="../types/ServerApiVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
628628
<li><a href="../types/ServerEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Events</span></a></li>
629+
<li><a href="../types/ServerMonitoringMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
629630
<li><a href="../types/ServerSessionId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Session<wbr/>Id</span></a></li>
630631
<li><a href="../types/ServerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Type</span></a></li>
631632
<li><a href="../types/SetFields.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Set<wbr/>Fields</span></a></li>
@@ -665,6 +666,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
665666
<li><a href="../variables/ReadPreferenceMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Read<wbr/>Preference<wbr/>Mode</span></a></li>
666667
<li><a href="../variables/ReturnDocument-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Return<wbr/>Document</span></a></li>
667668
<li><a href="../variables/ServerApiVersion-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
669+
<li><a href="../variables/ServerMonitoringMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
668670
<li><a href="../variables/ServerType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Type</span></a></li>
669671
<li><a href="../variables/TopologyType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Topology<wbr/>Type</span></a></li></ul></nav></div></div></div>
670672
<div class="tsd-generator">

docs/Next/classes/AggregationCursor.html

Lines changed: 216 additions & 87 deletions
Large diffs are not rendered by default.

docs/Next/classes/BSON.BSONError.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ <h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-tr
114114
</div></li></ul></li></ul></div><aside class="tsd-sources">
115115
<p>Inherited from Error.prepareStackTrace</p>
116116
<ul>
117-
<li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
117+
<li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section>
118118
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
119119
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
120120
<div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
121121
<p>Inherited from Error.stackTraceLimit</p>
122122
<ul>
123-
<li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
123+
<li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section>
124124
<section class="tsd-panel-group tsd-member-group">
125125
<h2>Accessors</h2>
126126
<section class="tsd-panel tsd-member tsd-is-external"><a id="name" class="tsd-anchor"></a>
@@ -152,7 +152,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
152152
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
153153
<p>Inherited from Error.captureStackTrace</p>
154154
<ul>
155-
<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section>
155+
<li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section>
156156
<section class="tsd-panel tsd-member tsd-is-external"><a id="isBSONError" class="tsd-anchor"></a>
157157
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>isBSONError</span><a href="#isBSONError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
158158
<ul class="tsd-signatures tsd-is-external">
@@ -603,6 +603,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
603603
<li><a href="../types/SchemaMember.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Schema<wbr/>Member</span></a></li>
604604
<li><a href="../types/ServerApiVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
605605
<li><a href="../types/ServerEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Events</span></a></li>
606+
<li><a href="../types/ServerMonitoringMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
606607
<li><a href="../types/ServerSessionId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Session<wbr/>Id</span></a></li>
607608
<li><a href="../types/ServerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Type</span></a></li>
608609
<li><a href="../types/SetFields.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Set<wbr/>Fields</span></a></li>
@@ -642,6 +643,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
642643
<li><a href="../variables/ReadPreferenceMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Read<wbr/>Preference<wbr/>Mode</span></a></li>
643644
<li><a href="../variables/ReturnDocument-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Return<wbr/>Document</span></a></li>
644645
<li><a href="../variables/ServerApiVersion-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
646+
<li><a href="../variables/ServerMonitoringMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
645647
<li><a href="../variables/ServerType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Type</span></a></li>
646648
<li><a href="../variables/TopologyType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Topology<wbr/>Type</span></a></li></ul></nav></div></div></div>
647649
<div class="tsd-generator">

docs/Next/classes/BSON.BSONRegExp.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,20 @@ <h2>Methods</h2>
105105
<section class="tsd-panel tsd-member tsd-is-external"><a id="inspect" class="tsd-anchor"></a>
106106
<h3 class="tsd-anchor-link"><span>inspect</span><a href="#inspect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
107107
<ul class="tsd-signatures tsd-is-external">
108-
<li class="tsd-signature tsd-anchor-link" id="inspect.inspect-1"><span class="tsd-kind-call-signature">inspect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#inspect.inspect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
108+
<li class="tsd-signature tsd-anchor-link" id="inspect.inspect-1"><span class="tsd-kind-call-signature">inspect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">depth</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">inspect</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#inspect.inspect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
109109
<li class="tsd-description">
110+
<div class="tsd-comment tsd-typography"><p>Prints a human-readable string of BSON value information
111+
If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify</p>
112+
</div>
113+
<div class="tsd-parameters">
114+
<h4 class="tsd-parameters-title">Parameters</h4>
115+
<ul class="tsd-parameter-list">
116+
<li>
117+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">depth</span>: <span class="tsd-signature-type">number</span></h5></li>
118+
<li>
119+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">unknown</span></h5></li>
120+
<li>
121+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">inspect</span>: <span class="tsd-signature-type ">InspectFn</span></h5></li></ul></div>
110122
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
111123
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
112124
<p>Overrides <a href="BSON.BSONValue.html">BSONValue</a>.<a href="BSON.BSONValue.html#inspect">inspect</a></p>
@@ -551,6 +563,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
551563
<li><a href="../types/SchemaMember.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Schema<wbr/>Member</span></a></li>
552564
<li><a href="../types/ServerApiVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
553565
<li><a href="../types/ServerEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Events</span></a></li>
566+
<li><a href="../types/ServerMonitoringMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
554567
<li><a href="../types/ServerSessionId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Session<wbr/>Id</span></a></li>
555568
<li><a href="../types/ServerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Type</span></a></li>
556569
<li><a href="../types/SetFields.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Set<wbr/>Fields</span></a></li>
@@ -590,6 +603,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
590603
<li><a href="../variables/ReadPreferenceMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Read<wbr/>Preference<wbr/>Mode</span></a></li>
591604
<li><a href="../variables/ReturnDocument-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Return<wbr/>Document</span></a></li>
592605
<li><a href="../variables/ServerApiVersion-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
606+
<li><a href="../variables/ServerMonitoringMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
593607
<li><a href="../variables/ServerType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Type</span></a></li>
594608
<li><a href="../variables/TopologyType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Topology<wbr/>Type</span></a></li></ul></nav></div></div></div>
595609
<div class="tsd-generator">

docs/Next/classes/BSON.BSONRuntimeError.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ <h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-tr
111111
</div></li></ul></li></ul></div><aside class="tsd-sources">
112112
<p>Inherited from <a href="BSON.BSONError.html">BSONError</a>.<a href="BSON.BSONError.html#prepareStackTrace">prepareStackTrace</a></p>
113113
<ul>
114-
<li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
114+
<li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section>
115115
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
116116
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
117117
<div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
118118
<p>Inherited from <a href="BSON.BSONError.html">BSONError</a>.<a href="BSON.BSONError.html#stackTraceLimit">stackTraceLimit</a></p>
119119
<ul>
120-
<li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
120+
<li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section>
121121
<section class="tsd-panel-group tsd-member-group">
122122
<h2>Accessors</h2>
123123
<section class="tsd-panel tsd-member tsd-is-external"><a id="name" class="tsd-anchor"></a>
@@ -149,7 +149,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
149149
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
150150
<p>Inherited from <a href="BSON.BSONError.html">BSONError</a>.<a href="BSON.BSONError.html#captureStackTrace">captureStackTrace</a></p>
151151
<ul>
152-
<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section>
152+
<li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section>
153153
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isBSONError" class="tsd-anchor"></a>
154154
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>isBSONError</span><a href="#isBSONError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
155155
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -601,6 +601,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
601601
<li><a href="../types/SchemaMember.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Schema<wbr/>Member</span></a></li>
602602
<li><a href="../types/ServerApiVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
603603
<li><a href="../types/ServerEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Events</span></a></li>
604+
<li><a href="../types/ServerMonitoringMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
604605
<li><a href="../types/ServerSessionId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Session<wbr/>Id</span></a></li>
605606
<li><a href="../types/ServerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>Type</span></a></li>
606607
<li><a href="../types/SetFields.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Set<wbr/>Fields</span></a></li>
@@ -640,6 +641,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
640641
<li><a href="../variables/ReadPreferenceMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Read<wbr/>Preference<wbr/>Mode</span></a></li>
641642
<li><a href="../variables/ReturnDocument-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Return<wbr/>Document</span></a></li>
642643
<li><a href="../variables/ServerApiVersion-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Api<wbr/>Version</span></a></li>
644+
<li><a href="../variables/ServerMonitoringMode-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Monitoring<wbr/>Mode</span></a></li>
643645
<li><a href="../variables/ServerType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Server<wbr/>Type</span></a></li>
644646
<li><a href="../variables/TopologyType-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Topology<wbr/>Type</span></a></li></ul></nav></div></div></div>
645647
<div class="tsd-generator">

0 commit comments

Comments
 (0)