Merge pull request #554 from nats-io/ordered-consumer-options-doc

[DOC] added js doc to the ordered consumer options

docs/enums/AdvisoryKind.html

@@ -19,7 +19,7 @@ <h1>Enumeration AdvisoryKind</h1></div>
 <div class="tsd-comment tsd-typography"><p>The different kinds of Advisories</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:833</li></ul></aside>
+<li>Defined in cjs/jetstream/types.ts:834</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">
@@ -48,72 +48,72 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>API</span><a href="#API" 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">API<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;api_audit&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:834</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:835</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Ack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Ack</span><a href="#Ack" 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">Ack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consumer_ack&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:843</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:844</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ConsumerAction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Consumer<wbr/>Action</span><a href="#ConsumerAction" 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">Consumer<wbr/>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consumer_action&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:836</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:837</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ConsumerLeaderElected" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Consumer<wbr/>Leader<wbr/>Elected</span><a href="#ConsumerLeaderElected" 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">Consumer<wbr/>Leader<wbr/>Elected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consumer_leader_elected&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:846</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:847</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ConsumerQuorumLost" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Consumer<wbr/>Quorum<wbr/>Lost</span><a href="#ConsumerQuorumLost" 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">Consumer<wbr/>Quorum<wbr/>Lost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consumer_quorum_lost&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:847</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:848</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MaxDeliver" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Max<wbr/>Deliver</span><a href="#MaxDeliver" 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">Max<wbr/>Deliver<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;max_deliver&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:841</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:842</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RestoreComplete" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Restore<wbr/>Complete</span><a href="#RestoreComplete" 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">Restore<wbr/>Complete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;restore_complete&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:840</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:841</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RestoreCreate" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Restore<wbr/>Create</span><a href="#RestoreCreate" 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">Restore<wbr/>Create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;restore_create&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:839</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:840</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SnapshotComplete" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Snapshot<wbr/>Complete</span><a href="#SnapshotComplete" 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">Snapshot<wbr/>Complete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;snapshot_complete&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:838</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:839</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SnapshotCreate" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Snapshot<wbr/>Create</span><a href="#SnapshotCreate" 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">Snapshot<wbr/>Create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;snapshot_create&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:837</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:838</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="StreamAction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Stream<wbr/>Action</span><a href="#StreamAction" 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<wbr/>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stream_action&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:835</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:836</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="StreamLeaderElected" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Stream<wbr/>Leader<wbr/>Elected</span><a href="#StreamLeaderElected" 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<wbr/>Leader<wbr/>Elected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stream_leader_elected&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:844</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:845</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="StreamQuorumLost" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Stream<wbr/>Quorum<wbr/>Lost</span><a href="#StreamQuorumLost" 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<wbr/>Quorum<wbr/>Lost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stream_quorum_lost&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:845</li></ul></aside></section>
+<li>Defined in cjs/jetstream/types.ts:846</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Terminated" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Terminated</span><a href="#Terminated" 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">Terminated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;terminated&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/types.ts:842</li></ul></aside></section></section></div>
+<li>Defined in cjs/jetstream/types.ts:843</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">

docs/enums/ConsumerDebugEvents.html

@@ -20,7 +20,7 @@ <h1>Enumeration ConsumerDebugEvents</h1></div>
 that can be safely ignored by clients.</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:161</li></ul></aside>
+<li>Defined in cjs/jetstream/consumer.ts:162</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">
@@ -42,7 +42,7 @@ <h3 class="tsd-anchor-link"><span>Debug<wbr/>Event</span><a href="#DebugEvent" a
 status is just a string indicating the code/message of the status.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:167</li></ul></aside></section>
+<li>Defined in cjs/jetstream/consumer.ts:168</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Discard" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Discard</span><a href="#Discard" 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">Discard<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;discard&quot;</span></div>
@@ -52,7 +52,7 @@ <h3 class="tsd-anchor-link"><span>Discard</span><a href="#Discard" aria-label="P
 have the format of <code>{msgsLeft: number, bytesLeft: number}</code>.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:174</li></ul></aside></section>
+<li>Defined in cjs/jetstream/consumer.ts:175</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><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 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">Next<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;next&quot;</span></div>
@@ -61,7 +61,7 @@ <h3 class="tsd-anchor-link"><span>Next</span><a href="#Next" aria-label="Permali
 read-only. This notification is only useful for debugging. Data is PullOptions.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:180</li></ul></aside></section></section></div>
+<li>Defined in cjs/jetstream/consumer.ts:181</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">

docs/enums/ConsumerEvents.html

@@ -20,7 +20,7 @@ <h1>Enumeration ConsumerEvents</h1></div>
 that may be of interest to a client.</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:147</li></ul></aside>
+<li>Defined in cjs/jetstream/consumer.ts:148</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">
@@ -41,7 +41,7 @@ <h3 class="tsd-anchor-link"><span>Heartbeats<wbr/>Missed</span><a href="#Heartbe
 the client is disconnected.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in cjs/jetstream/consumer.ts:154</li></ul></aside></section></section></div>
+<li>Defined in cjs/jetstream/consumer.ts:155</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">