Skip to content

Commit

Permalink
Minor refactor for performance and code cohesion.
Browse files Browse the repository at this point in the history 
- Improved types across the board
- Improved hook documentation with examples
- Simplified PusherProvider, usePresenceChannel, useTrigger
- removed duplicate invariants covered by useChannel

Small note - dts-bundle-generator doesn't export the Pusher type as default from 'pusher-js'. I manually updated it before releasing to npm - would be good to write a script to do that automatically.

Merge branch 'feature/improve-types-refactor' into develop
  • Loading branch information
Harley Alexander committed Feb 18, 2020
2 parents 876cc4c + 688e155 commit 72da50b
Show file tree
Hide file tree
Showing 31 changed files with 369 additions and 532 deletions.
3 changes: 3 additions & 0 deletions .netlify/state.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"siteId": "aa919ed6-b843-411b-b6f7-828ea279b040"
}
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

27 changes: 15 additions & 12 deletions docs/classes/_mocks_.pusherchannelmock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L7">src/mocks.ts:7</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L9">src/mocks.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -145,7 +145,7 @@ <h3>callbacks</h3>
<div class="tsd-signature tsd-kind-icon">callbacks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L6">src/mocks.ts:6</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L8">src/mocks.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -157,7 +157,7 @@ <h3>callbacks</h3>
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h5>
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../modules/_mocks_.html#callbacksignature" class="tsd-signature-type">CallbackSignature</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</div>
Expand All @@ -168,7 +168,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L7">src/mocks.ts:7</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L9">src/mocks.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -179,13 +179,13 @@ <h2>Methods</h2>
<a name="bind" class="tsd-anchor"></a>
<h3>bind</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_mocks_.html#callbacksignature" class="tsd-signature-type">CallbackSignature</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L18">src/mocks.ts:18</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L20">src/mocks.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -202,7 +202,7 @@ <h5>name: <span class="tsd-signature-type">string</span></h5>
</div>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">Function</span></h5>
<h5>callback: <a href="../modules/_mocks_.html#callbacksignature" class="tsd-signature-type">CallbackSignature</a></h5>
<div class="tsd-comment tsd-typography">
<p>callback to be called on event.</p>
</div>
Expand All @@ -222,7 +222,7 @@ <h3>emit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L37">src/mocks.ts:37</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L39">src/mocks.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -262,7 +262,7 @@ <h3>trigger</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L45">src/mocks.ts:45</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L47">src/mocks.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -273,13 +273,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="unbind" class="tsd-anchor"></a>
<h3>unbind</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unbind<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">unbind<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_mocks_.html#callbacksignature" class="tsd-signature-type">CallbackSignature</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L28">src/mocks.ts:28</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L30">src/mocks.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -296,7 +296,7 @@ <h5>name: <span class="tsd-signature-type">string</span></h5>
</div>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">Function</span></h5>
<h5>callback: <a href="../modules/_mocks_.html#callbacksignature" class="tsd-signature-type">CallbackSignature</a></h5>
<div class="tsd-comment tsd-typography">
<p>callback to be called on event.</p>
</div>
Expand Down Expand Up @@ -381,6 +381,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_mocks_.pusherpresencechannelmock.html" class="tsd-kind-icon">Pusher<wbr>Presence<wbr>Channel<wbr>Mock</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_mocks_.html#callbacksignature" class="tsd-kind-icon">Callback<wbr>Signature</a>
</li>
</ul>
</nav>
</div>
Expand Down
19 changes: 11 additions & 8 deletions docs/classes/_mocks_.pushermock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L64">src/mocks.ts:64</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L66">src/mocks.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -149,7 +149,7 @@ <h3>channels</h3>
<div class="tsd-signature tsd-kind-icon">channels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L64">src/mocks.ts:64</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L66">src/mocks.ts:66</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -167,7 +167,7 @@ <h3>config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Options</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L63">src/mocks.ts:63</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L65">src/mocks.ts:65</a></li>
</ul>
</aside>
</section>
Expand All @@ -177,7 +177,7 @@ <h3>key</h3>
<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L62">src/mocks.ts:62</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L64">src/mocks.ts:64</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +194,7 @@ <h3>channel</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L77">src/mocks.ts:77</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L79">src/mocks.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -226,7 +226,7 @@ <h3>disconnect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L107">src/mocks.ts:107</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L109">src/mocks.ts:109</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -243,7 +243,7 @@ <h3>subscribe</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L92">src/mocks.ts:92</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L94">src/mocks.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -275,7 +275,7 @@ <h3>unsubscribe</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/9c270b7/src/mocks.ts#L100">src/mocks.ts:100</a></li>
<li>Defined in <a href="https://github.com/mayteio/use-pusher/blob/bb1fbb2/src/mocks.ts#L102">src/mocks.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -374,6 +374,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_mocks_.pusherpresencechannelmock.html" class="tsd-kind-icon">Pusher<wbr>Presence<wbr>Channel<wbr>Mock</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_mocks_.html#callbacksignature" class="tsd-kind-icon">Callback<wbr>Signature</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit 72da50b

Please sign in to comment.