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.

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

[DOC] regenerated docs #603

Merged
merged 1 commit into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/classes/ServiceError.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ServiceError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in cjs/nats-base-client/core.ts:1036</li></ul></aside>
<li>Defined in cjs/nats-base-client/core.ts:1056</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -65,7 +65,7 @@ <h5>message: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ServiceError.html" class="tsd-signature-type" data-tsd-kind="Class">ServiceError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in cjs/nats-base-client/core.ts:1039</li></ul></aside></li></ul></section></section>
<li>Defined in cjs/nats-base-client/core.ts:1059</li></ul></aside></li></ul></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-class tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
Expand All @@ -78,7 +78,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/nats-base-client/core.ts:1037</li></ul></aside></section>
<li>Defined in cjs/nats-base-client/core.ts:1057</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand Down Expand Up @@ -160,7 +160,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>msg: <a href="../interfaces/Msg.html" class="tsd-signature-type" data-tsd-kind="Interface">Msg</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in cjs/nats-base-client/core.ts:1044</li></ul></aside></li></ul></section>
<li>Defined in cjs/nats-base-client/core.ts:1064</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toServiceError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Service<wbr/>Error</span><a href="#toServiceError" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -173,7 +173,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>msg: <a href="../interfaces/Msg.html" class="tsd-signature-type" data-tsd-kind="Interface">Msg</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ServiceError.html" class="tsd-signature-type" data-tsd-kind="Class">ServiceError</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in cjs/nats-base-client/core.ts:1048</li></ul></aside></li></ul></section></section></div>
<li>Defined in cjs/nats-base-client/core.ts:1068</li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
8 changes: 4 additions & 4 deletions docs/enums/AckPolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="AckPolicy.html">AckPolicy</a></li></ul>
<h1>Enumeration AckPolicy</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:383</li></ul></aside>
<li>Defined in cjs/jetstream/jsapi_types.ts:413</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -36,21 +36,21 @@ <h3 class="tsd-anchor-link"><span>All</span><a href="#All" aria-label="Permalink
<div class="tsd-comment tsd-typography"><p>Ack, acknowledges all messages with a lower sequence</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:391</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:421</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Explicit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Explicit</span><a href="#Explicit" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Explicit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;explicit&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>All sequences must be explicitly acknowledged</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:395</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:425</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="None" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>None</span><a href="#None" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">None<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;none&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Messages don&#39;t need to be Ack&#39;ed.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:387</li></ul></aside></section></section></div>
<li>Defined in cjs/jetstream/jsapi_types.ts:417</li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
14 changes: 7 additions & 7 deletions docs/enums/DeliverPolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="DeliverPolicy.html">DeliverPolicy</a></li></ul>
<h1>Enumeration DeliverPolicy</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:356</li></ul></aside>
<li>Defined in cjs/jetstream/jsapi_types.ts:386</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -39,42 +39,42 @@ <h3 class="tsd-anchor-link"><span>All</span><a href="#All" aria-label="Permalink
<div class="tsd-comment tsd-typography"><p>Deliver all messages</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:360</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:390</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Last" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Last</span><a href="#Last" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Last<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;last&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Deliver starting with the last message</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:364</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:394</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LastPerSubject" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Last<wbr/>Per<wbr/>Subject</span><a href="#LastPerSubject" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Last<wbr/>Per<wbr/>Subject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;last_per_subject&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Deliver starting with the last messages for every subject</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:380</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:410</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="New" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>New</span><a href="#New" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">New<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;new&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Deliver starting with new messages</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:368</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:398</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="StartSequence" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Start<wbr/>Sequence</span><a href="#StartSequence" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Start<wbr/>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;by_start_sequence&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Deliver starting with the specified sequence</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:372</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:402</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="StartTime" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Start<wbr/>Time</span><a href="#StartTime" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Start<wbr/>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;by_start_time&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Deliver starting with the specified time</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:376</li></ul></aside></section></section></div>
<li>Defined in cjs/jetstream/jsapi_types.ts:406</li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
10 changes: 5 additions & 5 deletions docs/enums/DirectMsgHeaders.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="DirectMsgHeaders.html">DirectMsgHeaders</a></li></ul>
<h1>Enumeration DirectMsgHeaders</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/types.ts:1345</li></ul></aside>
<li>Defined in cjs/jetstream/types.ts:1537</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -35,22 +35,22 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>Sequence</span><a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Sequence&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/types.ts:1347</li></ul></aside></section>
<li>Defined in cjs/jetstream/types.ts:1539</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stream" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Stream</span><a href="#Stream" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Stream&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/types.ts:1346</li></ul></aside></section>
<li>Defined in cjs/jetstream/types.ts:1538</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Subject" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Subject</span><a href="#Subject" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Subject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Subject&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/types.ts:1349</li></ul></aside></section>
<li>Defined in cjs/jetstream/types.ts:1541</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TimeStamp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Time<wbr/>Stamp</span><a href="#TimeStamp" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Time<wbr/>Stamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Time-Stamp&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/types.ts:1348</li></ul></aside></section></section></div>
<li>Defined in cjs/jetstream/types.ts:1540</li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
6 changes: 3 additions & 3 deletions docs/enums/DiscardPolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="DiscardPolicy.html">DiscardPolicy</a></li></ul>
<h1>Enumeration DiscardPolicy</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:334</li></ul></aside>
<li>Defined in cjs/jetstream/jsapi_types.ts:364</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -35,14 +35,14 @@ <h3 class="tsd-anchor-link"><span>New</span><a href="#New" aria-label="Permalink
<div class="tsd-comment tsd-typography"><p>Discard the new messages</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:342</li></ul></aside></section>
<li>Defined in cjs/jetstream/jsapi_types.ts:372</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Old" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Old</span><a href="#Old" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Old<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;old&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Discard old messages to make room for the new ones</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs/jetstream/jsapi_types.ts:338</li></ul></aside></section></section></div>
<li>Defined in cjs/jetstream/jsapi_types.ts:368</li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading
Loading