Skip to content

Commit

Permalink
update docs and version on package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
beeblebrox3 committed Feb 18, 2023
1 parent 97144a3 commit 4d97c8d
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
30 changes: 15 additions & 15 deletions docs/classes/BufferedEventEmitter.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">BufferedEventEmitter</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L22">BufferedEventEmitter.ts:22</a></li></ul></aside>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L22">BufferedEventEmitter.ts:22</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 @@ -63,19 +63,19 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>options: <a href="../interfaces/BufferedEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BufferedEventEmitterOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L32">BufferedEventEmitter.ts:32</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L32">BufferedEventEmitter.ts:32</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-kind-property tsd-parent-kind-class"><a id="CLEAN_BUFFER_EVENT_NAME" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>CLEAN_<wbr/>BUFFER_<wbr/>EVENT_<wbr/>NAME</span><a href="#CLEAN_BUFFER_EVENT_NAME" 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">CLEAN_<wbr/>BUFFER_<wbr/>EVENT_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = CLEAN_BUFFER_EVENT_NAME</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L30">BufferedEventEmitter.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L30">BufferedEventEmitter.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="FLUSH_BUFFER_EVENT_NAME" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>FLUSH_<wbr/>BUFFER_<wbr/>EVENT_<wbr/>NAME</span><a href="#FLUSH_BUFFER_EVENT_NAME" 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">FLUSH_<wbr/>BUFFER_<wbr/>EVENT_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = FLUSH_BUFFER_EVENT_NAME</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L29">BufferedEventEmitter.ts:29</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L29">BufferedEventEmitter.ts:29</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="cleanBuffer" class="tsd-anchor"></a>
Expand All @@ -92,7 +92,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>bufferId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L121">BufferedEventEmitter.ts:121</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L121">BufferedEventEmitter.ts:121</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createBuffer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Buffer</span><a href="#createBuffer" 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 @@ -109,7 +109,7 @@ <h5>bufferId: <span class="tsd-signature-type">string</span><span class="tsd-sig
<h5>context: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L48">BufferedEventEmitter.ts:48</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L48">BufferedEventEmitter.ts:48</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 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 @@ -131,7 +131,7 @@ <h5>eventName: <span class="tsd-signature-type">string</span></h5>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L210">BufferedEventEmitter.ts:210</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L210">BufferedEventEmitter.ts:210</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="emitBuffered" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>emit<wbr/>Buffered</span><a href="#emitBuffered" 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 @@ -151,7 +151,7 @@ <h5>eventName: <span class="tsd-signature-type">string</span></h5></li>
<h5>message: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L70">BufferedEventEmitter.ts:70</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L70">BufferedEventEmitter.ts:70</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="flush" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>flush</span><a href="#flush" 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 @@ -167,7 +167,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>bufferId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L91">BufferedEventEmitter.ts:91</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L91">BufferedEventEmitter.ts:91</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setDebugMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Debug<wbr/>Mode</span><a href="#setDebugMode" 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 @@ -182,7 +182,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>value: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L40">BufferedEventEmitter.ts:40</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L40">BufferedEventEmitter.ts:40</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="subscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" 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 @@ -201,7 +201,7 @@ <h5>eventName: <span class="tsd-signature-type">string</span></h5></li>
<h5>fn: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L139">BufferedEventEmitter.ts:139</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L139">BufferedEventEmitter.ts:139</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="subscribeMultiple" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>subscribe<wbr/>Multiple</span><a href="#subscribeMultiple" 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 Down Expand Up @@ -229,7 +229,7 @@ <h5>fn: <span class="tsd-signature-type">Function</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L158">BufferedEventEmitter.ts:158</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L158">BufferedEventEmitter.ts:158</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unsubscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" 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 @@ -250,7 +250,7 @@ <h5>fn: <span class="tsd-signature-type">Function</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L169">BufferedEventEmitter.ts:169</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L169">BufferedEventEmitter.ts:169</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unsubscribeAll" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>All</span><a href="#unsubscribeAll" 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 @@ -265,7 +265,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>eventNames: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L196">BufferedEventEmitter.ts:196</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L196">BufferedEventEmitter.ts:196</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unsubscribeMultiple" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>Multiple</span><a href="#unsubscribeMultiple" 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 @@ -284,7 +284,7 @@ <h5>eventNames: <span class="tsd-signature-type">string</span><span class="tsd-s
<h5>fn: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="BufferedEventEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">BufferedEventEmitter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/faa91f1/src/BufferedEventEmitter.ts#L183">BufferedEventEmitter.ts:183</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/beeblebrox3/sbee/blob/97144a3/src/BufferedEventEmitter.ts#L183">BufferedEventEmitter.ts:183</a></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
Loading

0 comments on commit 4d97c8d

Please sign in to comment.