Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@morris
morris committed Sep 15, 2023
1 parent fde2b04 commit 8070422
Show file tree
Hide file tree
Showing 24 changed files with 148 additions and 92 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/classes/BatchPublisher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">BatchPublisher</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/BatchPublisher.ts#L45">src/BatchPublisher.ts:45</a></li></ul></aside>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/BatchPublisher.ts#L45">src/BatchPublisher.ts:45</a></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 @@ -92,7 +92,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Batc
<h4 class="tsd-returns-title">Returns <a href="BatchPublisher.html" class="tsd-signature-type tsd-kind-class">BatchPublisher</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TMessage</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Overrides TypedEventEmitter&lt;BatchPublisherEvents&lt;TMessage&gt;&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/BatchPublisher.ts#L57">src/BatchPublisher.ts:57</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/BatchPublisher.ts#L57">src/BatchPublisher.ts:57</a></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-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
Expand Down Expand Up @@ -199,7 +199,7 @@ <h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Perma
<li class="tsd-description">
<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">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/BatchPublisher.ts#L92">src/BatchPublisher.ts:92</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/BatchPublisher.ts#L92">src/BatchPublisher.ts:92</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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 tsd-is-external">
Expand Down Expand Up @@ -593,7 +593,7 @@ <h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/BatchPublisher.ts#L78">src/BatchPublisher.ts:78</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/BatchPublisher.ts#L78">src/BatchPublisher.ts:78</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" 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
10 changes: 5 additions & 5 deletions docs/classes/Consumer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Consumer</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/Consumer.ts#L67">src/Consumer.ts:67</a></li></ul></aside>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/Consumer.ts#L75">src/Consumer.ts:75</a></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 @@ -95,7 +95,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Cons
<h4 class="tsd-returns-title">Returns <a href="Consumer.html" class="tsd-signature-type tsd-kind-class">Consumer</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TMessage</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Overrides TypedEventEmitter&lt;ConsumerEvents&lt;TMessage&gt;&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/Consumer.ts#L90">src/Consumer.ts:90</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/Consumer.ts#L99">src/Consumer.ts:99</a></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-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
Expand Down Expand Up @@ -202,7 +202,7 @@ <h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Perma
<li class="tsd-description">
<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">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/Consumer.ts#L155">src/Consumer.ts:155</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/Consumer.ts#L165">src/Consumer.ts:165</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="drain" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>drain</span><a href="#drain" 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 All @@ -219,7 +219,7 @@ <h5><span class="tsd-kind-parameter">timeoutMs</span>: <span class="tsd-signatur
<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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/Consumer.ts#L138">src/Consumer.ts:138</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/Consumer.ts#L148">src/Consumer.ts:148</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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 tsd-is-external">
Expand Down Expand Up @@ -728,7 +728,7 @@ <h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Perma
<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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/f005114/src/Consumer.ts#L129">src/Consumer.ts:129</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/morris/mongomq2/blob/fde2b04/src/Consumer.ts#L139">src/Consumer.ts:139</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" 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

0 comments on commit 8070422

Please sign in to comment.