Skip to content

Commit 92a907d

Browse files
[create-pull-request] automated change
1 parent 69de253 commit 92a907d

28 files changed

+146
-149
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/ConnectionPoolCreatedEvent.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h3 class="tsd-anchor-link"><span>address</span><a href="#address" aria-label="P
5151
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L28">src/cmap/connection_pool_events.ts:28</a></li></ul></aside></section>
5252
<section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a>
5353
<h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
54-
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ConnectionPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ConnectionPoolOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;maxPoolSize&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;minPoolSize&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;maxConnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;maxIdleTimeMS&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;waitQueueTimeoutMS&quot;</span><span class="tsd-signature-symbol">&gt;</span></div>
54+
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ConnectionPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ConnectionPoolOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;maxConnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;maxIdleTimeMS&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;maxPoolSize&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;minPoolSize&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;waitQueueTimeoutMS&quot;</span><span class="tsd-signature-symbol">&gt;</span></div>
5555
<div class="tsd-comment tsd-typography"><p>The options used to create this connection pool</p>
5656
</div>
5757
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">

docs/Next/classes/Db.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
478478
<section class="tsd-panel tsd-member"><a id="listCollections" class="tsd-anchor"></a>
479479
<h3 class="tsd-anchor-link"><span>list<wbr/>Collections</span><a href="#listCollections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
480480
<ul class="tsd-signatures">
481-
<li class="tsd-signature tsd-anchor-link" id="listCollections.listCollections-1"><span class="tsd-kind-call-signature">list<wbr/>Collections</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListCollectionsCursor.html" class="tsd-signature-type tsd-kind-class">ListCollectionsCursor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#listCollections.listCollections-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
481+
<li class="tsd-signature tsd-anchor-link" id="listCollections.listCollections-1"><span class="tsd-kind-call-signature">list<wbr/>Collections</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListCollectionsCursor.html" class="tsd-signature-type tsd-kind-class">ListCollectionsCursor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#listCollections.listCollections-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
482482
<li class="tsd-description">
483483
<div class="tsd-comment tsd-typography"><p>List all collections of this database with optional filter</p>
484484
</div>
@@ -495,7 +495,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/List
495495
<div class="tsd-comment tsd-typography"><p>Optional settings for the command</p>
496496
</div>
497497
<div class="tsd-comment tsd-typography"></div></li></ul></div>
498-
<h4 class="tsd-returns-title">Returns <a href="ListCollectionsCursor.html" class="tsd-signature-type tsd-kind-class">ListCollectionsCursor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
498+
<h4 class="tsd-returns-title">Returns <a href="ListCollectionsCursor.html" class="tsd-signature-type tsd-kind-class">ListCollectionsCursor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
499499
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
500500
<ul>
501501
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/db.ts#L333">src/db.ts:333</a></li></ul></aside></li>
@@ -517,7 +517,7 @@ <h4 class="tsd-returns-title">Returns <a href="ListCollectionsCursor.html" class
517517
<h4>Type Parameters</h4>
518518
<ul class="tsd-type-parameter-list">
519519
<li>
520-
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span> = <a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
520+
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol">&gt;</span> = <a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CollectionInfo.html" class="tsd-signature-type tsd-kind-interface">CollectionInfo</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;type&quot;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
521521
<div class="tsd-parameters">
522522
<h4 class="tsd-parameters-title">Parameters</h4>
523523
<ul class="tsd-parameter-list">

docs/Next/classes/GridFSBucketReadStream.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2740,7 +2740,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
27402740
<li>
27412741
<h5><span class="tsd-kind-parameter">readableStream</span>: <span class="tsd-signature-type ">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li>
27422742
<li>
2743-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ReadableOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;objectMode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;highWaterMark&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;encoding&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
2743+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ReadableOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;signal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;objectMode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;highWaterMark&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;encoding&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
27442744
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4>
27452745
<div class="tsd-comment tsd-typography">
27462746
<h4>Since</h4><p>v17.0.0</p>

docs/Next/classes/GridFSBucketWriteStream.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2121,7 +2121,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
21212121
<li>
21222122
<h5><span class="tsd-kind-parameter">writableStream</span>: <span class="tsd-signature-type ">WritableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li>
21232123
<li>
2124-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">WritableOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;objectMode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;highWaterMark&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;decodeStrings&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
2124+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">WritableOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;signal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;objectMode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;highWaterMark&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;decodeStrings&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
21252125
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Writable</span></h4>
21262126
<div class="tsd-comment tsd-typography">
21272127
<h4>Since</h4><p>v17.0.0</p>

0 commit comments

Comments
 (0)