Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: generate docs from latest main [skip-ci] #3977

Merged
merged 1 commit into from
Feb 29, 2024
Merged

docs: generate docs from latest main [skip-ci] #3977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/Next/classes/AbstractCursor.html
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/Next/classes/AggregationCursor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ <h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#addCursorFlag">addCursorFlag</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L444">src/cursor/abstract_cursor.ts:444</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L450">src/cursor/abstract_cursor.ts:450</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand Down Expand Up @@ -416,7 +416,7 @@ <h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#batchSize">batchSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L567">src/cursor/abstract_cursor.ts:567</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L573">src/cursor/abstract_cursor.ts:573</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="bufferedCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>buffered<wbr/>Count</span><a href="#bufferedCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand Down Expand Up @@ -449,7 +449,7 @@ <h3 class="tsd-anchor-link"><span>close</span><a href="#close-1" aria-label="Per
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#close-1">close</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L418">src/cursor/abstract_cursor.ts:418</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L424">src/cursor/abstract_cursor.ts:424</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="emit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand Down Expand Up @@ -531,7 +531,7 @@ <h4>Deprecated</h4><ul>
</div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#forEach">forEach</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L406">src/cursor/abstract_cursor.ts:406</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L412">src/cursor/abstract_cursor.ts:412</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="geoNear" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>geo<wbr/>Near</span><a href="#geoNear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -586,7 +586,7 @@ <h3 class="tsd-anchor-link"><span>has<wbr/>Next</span><a href="#hasNext" aria-la
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#hasNext">hasNext</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L359">src/cursor/abstract_cursor.ts:359</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L365">src/cursor/abstract_cursor.ts:365</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="limit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -746,7 +746,7 @@ <h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#maxTimeMS">maxTimeMS</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L552">src/cursor/abstract_cursor.ts:552</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L558">src/cursor/abstract_cursor.ts:558</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="next" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>next</span><a href="#next" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand All @@ -758,7 +758,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#next">next</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L379">src/cursor/abstract_cursor.ts:379</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L385">src/cursor/abstract_cursor.ts:385</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="off" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand Down Expand Up @@ -1251,7 +1251,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#rewind">rewind</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L586">src/cursor/abstract_cursor.ts:586</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L592">src/cursor/abstract_cursor.ts:592</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setMaxListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand Down Expand Up @@ -1326,7 +1326,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#toArray">toArray</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L430">src/cursor/abstract_cursor.ts:430</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L436">src/cursor/abstract_cursor.ts:436</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="tryNext" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>try<wbr/>Next</span><a href="#tryNext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand All @@ -1338,7 +1338,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#tryNext">tryNext</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L390">src/cursor/abstract_cursor.ts:390</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L396">src/cursor/abstract_cursor.ts:396</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="unwind" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unwind</span><a href="#unwind" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -1371,7 +1371,7 @@ <h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#withReadConcern">withReadConcern</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L537">src/cursor/abstract_cursor.ts:537</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L543">src/cursor/abstract_cursor.ts:543</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="withReadPreference" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>with<wbr/>Read<wbr/>Preference</span><a href="#withReadPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand All @@ -1391,7 +1391,7 @@ <h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="AbstractCursor.html">AbstractCursor</a>.<a href="AbstractCursor.html#withReadPreference">withReadPreference</a></p>
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L519">src/cursor/abstract_cursor.ts:519</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/abstract_cursor.ts#L525">src/cursor/abstract_cursor.ts:525</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addAbortListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>add<wbr/>Abort<wbr/>Listener</span><a href="#addAbortListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
Expand Down
11 changes: 8 additions & 3 deletions docs/Next/classes/BSON.BSONError.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,18 @@ <h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-is-external"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><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></g></svg></a></h3>
<ul class="tsd-signatures tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_BSONError"><span class="tsd-kind-constructor-signature">new BSONError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BSON.BSONError.html" class="tsd-signature-type tsd-kind-class">BSONError</a><a href="#constructor.new_BSONError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="constructor.new_BSONError"><span class="tsd-kind-constructor-signature">new BSONError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BSON.BSONError.html" class="tsd-signature-type tsd-kind-class">BSONError</a><a href="#constructor.new_BSONError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BSON.BSONError.html" class="tsd-signature-type tsd-kind-class">BSONError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
Expand Down Expand Up @@ -173,7 +178,7 @@ <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><a href="BSON.BSONError.html" class="tsd-signature-type tsd-kind-class">BSONError</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in node_modules/bson/bson.d.ts:170</li></ul></aside></li></ul></section></section></div>
<li>Defined in node_modules/bson/bson.d.ts:172</li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading