Skip to content

Commit

Permalink
doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
aricart committed Jan 12, 2023
1 parent 6527682 commit 8312530
Show file tree
Hide file tree
Showing 72 changed files with 351 additions and 63 deletions.
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_src/service.ts:262</li></ul></aside>
<li>Defined in cjs_src/service.ts:265</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_src/service.ts:264</li></ul></aside></li></ul></section></section>
<li>Defined in cjs_src/service.ts:267</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_src/service.ts:263</li></ul></aside></section>
<li>Defined in cjs_src/service.ts:266</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_src/service.ts:269</li></ul></aside></li></ul></section>
<li>Defined in cjs_src/service.ts:272</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_src/service.ts:273</li></ul></aside></li></ul></section></section></div>
<li>Defined in cjs_src/service.ts:276</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
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_src/types.ts:2949</li></ul></aside>
<li>Defined in cjs_src/types.ts:2957</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_src/types.ts:2951</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2959</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_src/types.ts:2950</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2958</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_src/types.ts:2953</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2961</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_src/types.ts:2952</li></ul></aside></section></section></div>
<li>Defined in cjs_src/types.ts:2960</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
12 changes: 6 additions & 6 deletions docs/enums/RepublishHeaders.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="RepublishHeaders.html">RepublishHeaders</a></li></ul>
<h1>Enumeration RepublishHeaders</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2956</li></ul></aside>
<li>Defined in cjs_src/types.ts:2964</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 @@ -38,35 +38,35 @@ <h3 class="tsd-anchor-link"><span>Last<wbr/>Sequence</span><a href="#LastSequenc
<div class="tsd-comment tsd-typography"><p>The stream sequence id of the last message ingested to the same original subject (or 0 if none or deleted)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2972</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2980</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Sequence" class="tsd-anchor"></a>
<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"><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">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Sequence&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The sequence of the republished message</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2968</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2976</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Size" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Size</span><a href="#Size" 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">Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nats-Msg-Size&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The size in bytes of the message&#39;s body - Only if <a href="../interfaces/Republish.html#headers_only">headers_only</a> is set.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2976</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2984</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>
<div class="tsd-comment tsd-typography"><p>The source stream of the message</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2960</li></ul></aside></section>
<li>Defined in cjs_src/types.ts:2968</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>
<div class="tsd-comment tsd-typography"><p>The original subject of the message</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/types.ts:2964</li></ul></aside></section></section></div>
<li>Defined in cjs_src/types.ts:2972</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/ServiceVerb.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="ServiceVerb.html">ServiceVerb</a></li></ul>
<h1>Enumeration ServiceVerb</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/service.ts:43</li></ul></aside>
<li>Defined in cjs_src/service.ts:46</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>INFO</span><a href="#INFO" 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">INFO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;INFO&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/service.ts:46</li></ul></aside></section>
<li>Defined in cjs_src/service.ts:49</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="PING" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>PING</span><a href="#PING" 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">PING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PING&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/service.ts:44</li></ul></aside></section>
<li>Defined in cjs_src/service.ts:47</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SCHEMA" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SCHEMA</span><a href="#SCHEMA" 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">SCHEMA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SCHEMA&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/service.ts:47</li></ul></aside></section>
<li>Defined in cjs_src/service.ts:50</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="STATS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>STATS</span><a href="#STATS" 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">STATS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;STATS&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in cjs_src/service.ts:45</li></ul></aside></section></section></div>
<li>Defined in cjs_src/service.ts:48</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
1 change: 1 addition & 0 deletions docs/functions/JSONCodec.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-type-alias"><a href="../types/ObjectStoreMeta.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Object<wbr/>Store<wbr/>Meta</a></li>
<li class="tsd-kind-type-alias"><a href="../types/ObjectStoreMetaOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Object<wbr/>Store<wbr/>Meta<wbr/>Options</a></li>
<li class="tsd-kind-type-alias"><a href="../types/ObjectStoreOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Object<wbr/>Store<wbr/>Options</a></li>
<li class="tsd-kind-type-alias"><a href="../types/ObjectStorePutOpts.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Object<wbr/>Store<wbr/>Put<wbr/>Opts</a></li>
<li class="tsd-kind-type-alias"><a href="../types/ObjectStoreStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Object<wbr/>Store<wbr/>Status</a></li>
<li class="tsd-kind-type-alias"><a href="../types/ProtocolFilterFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Protocol<wbr/>Filter<wbr/>Fn</a></li>
<li class="tsd-kind-type-alias"><a href="../types/PurgeBySeq.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Purge<wbr/>By<wbr/>Seq</a></li>
Expand Down
Loading

0 comments on commit 8312530

Please sign in to comment.