Skip to content

Commit

Permalink
refactor: move the streaming and polling client to AsyncCreatable (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
tnoonan-salesforce authored Nov 8, 2018
1 parent 04fb140 commit 33939f1
Show file tree
Hide file tree
Showing 40 changed files with 7,900 additions and 832 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**/docs/* linguist-generated=true
**/docs/* linguist-documentation
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/classes/aliases.html
Original file line number Diff line number Diff line change
Expand Up @@ -1048,8 +1048,8 @@
<dt>example</dt>
<dd><p>const aliases = await Aliases.retrieve<Aliases>();
aliases.set(&#39;myAlias&#39;, <a href="mailto:&#39;[email protected]">&#39;[email protected]</a>&#39;);
await aliases.write();</p>
<p>// Shorthand to get an alias.
await aliases.write();
// Shorthand to get an alias.
const username: string = await Aliases.fetch(&#39;myAlias&#39;);</p>
</dd>
<dt>see</dt>
Expand Down Expand Up @@ -2198,7 +2198,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
<aside class="tsd-sources">
<p>Overrides <a href="configgroup.html">ConfigGroup</a>.<a href="configgroup.html#create">create</a></p>
<ul>
<li>Defined in config/aliases.ts:71</li>
<li>Defined in config/aliases.ts:70</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2239,7 +2239,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> fetch</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in config/aliases.ts:132</li>
<li>Defined in config/aliases.ts:131</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2314,7 +2314,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>File<wbr>Name</h3
<aside class="tsd-sources">
<p>Overrides <a href="configfile.html">ConfigFile</a>.<a href="configfile.html#getfilename">getFileName</a></p>
<ul>
<li>Defined in config/aliases.ts:47</li>
<li>Defined in config/aliases.ts:46</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -2341,7 +2341,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Options</h3>
<aside class="tsd-sources">
<p>Overrides <a href="configgroup.html">ConfigGroup</a>.<a href="configgroup.html#getoptions">getOptions</a></p>
<ul>
<li>Defined in config/aliases.ts:55</li>
<li>Defined in config/aliases.ts:54</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -2363,7 +2363,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>And<wbr>Update<
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in config/aliases.ts:100</li>
<li>Defined in config/aliases.ts:99</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2438,7 +2438,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> retrieve</h3>
<aside class="tsd-sources">
<p>Overrides <a href="configfile.html">ConfigFile</a>.<a href="configfile.html#retrieve">retrieve</a></p>
<ul>
<li>Defined in config/aliases.ts:85</li>
<li>Defined in config/aliases.ts:84</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
17 changes: 8 additions & 9 deletions docs/classes/cometclient.html
Original file line number Diff line number Diff line change
Expand Up @@ -1075,13 +1075,13 @@ <h2>Methods</h2>
<a name="addextension" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> add<wbr>Extension</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Extension<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dictionary</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">add<wbr>Extension<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><a href="../interfaces/streamingextension.html" class="tsd-signature-type">StreamingExtension</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 status/streamingClient.ts:36</li>
<li>Defined in status/streamingClient.ts:56</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1096,7 +1096,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> add<wbr>Extension</h3
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>extension: <span class="tsd-signature-type">Dictionary</span></h5>
<h5>extension: <a href="../interfaces/streamingextension.html" class="tsd-signature-type">StreamingExtension</a></h5>
<div class="tsd-comment tsd-typography">
<p>The json function for the extension.</p>
</div>
Expand Down Expand Up @@ -1162,7 +1162,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> disable</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in status/streamingClient.ts:29</li>
<li>Defined in status/streamingClient.ts:49</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1197,7 +1197,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> disconnect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in status/streamingClient.ts:64</li>
<li>Defined in status/streamingClient.ts:83</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand Down Expand Up @@ -1280,7 +1280,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> handshake</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in status/streamingClient.ts:52</li>
<li>Defined in status/streamingClient.ts:72</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1704,7 +1704,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> set<wbr>Header</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in status/streamingClient.ts:44</li>
<li>Defined in status/streamingClient.ts:64</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1770,7 +1770,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> subscribe</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in status/streamingClient.ts:60</li>
<li>Defined in status/streamingClient.ts:79</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1812,7 +1812,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/cometsubscription.html" class="tsd-signature-type">CometSubscription</a></h4>
<p>A subscription object.</p>
</li>
</ul>
</section>
Expand Down
40 changes: 21 additions & 19 deletions docs/classes/connection.html
Original file line number Diff line number Diff line change
Expand Up @@ -1244,7 +1244,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides Connection.__constructor</p>
<ul>
<li>Defined in connection.ts:120</li>
<li>Defined in connection.ts:121</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -1361,7 +1361,7 @@ <h3>tooling</h3>
<aside class="tsd-sources">
<p>Overrides Connection.tooling</p>
<ul>
<li>Defined in connection.ts:112</li>
<li>Defined in connection.ts:113</li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -1491,7 +1491,7 @@ <h3>auto<wbr>Fetch<wbr>Query</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:283</li>
<li>Defined in connection.ts:284</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1536,7 +1536,7 @@ <h3>base<wbr>Url</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:184</li>
<li>Defined in connection.ts:185</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1822,7 +1822,7 @@ <h3>get<wbr>Api<wbr>Version</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:220</li>
<li>Defined in connection.ts:221</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1844,7 +1844,7 @@ <h3>get<wbr>Auth<wbr>Info<wbr>Fields</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:243</li>
<li>Defined in connection.ts:244</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1867,7 +1867,7 @@ <h3>get<wbr>Connection<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:247</li>
<li>Defined in connection.ts:248</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/authfields.html" class="tsd-signature-type">AuthFields</a></h4>
Expand Down Expand Up @@ -1903,7 +1903,7 @@ <h3>get<wbr>Username</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:255</li>
<li>Defined in connection.ts:256</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1988,7 +1988,7 @@ <h3>is<wbr>Using<wbr>Access<wbr>Token</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:263</li>
<li>Defined in connection.ts:264</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2222,7 +2222,7 @@ <h3>normalize<wbr>Url</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:271</li>
<li>Defined in connection.ts:272</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2681,7 +2681,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</spa
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">JsonMap</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">JsonCollection</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand Down Expand Up @@ -2710,11 +2710,13 @@ <h5>request: <span class="tsd-signature-type">RequestInfo</span><span class="tsd
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">JsonMap</span></h5>
<div class="tsd-comment tsd-typography">
<p>HTTP API request options.</p>
</div>
</li>
</ul>
<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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The request Promise.</p>
<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">JsonCollection</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand All @@ -2728,7 +2730,7 @@ <h3>request<wbr>Raw</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:166</li>
<li>Defined in connection.ts:167</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2804,7 +2806,7 @@ <h3>retrieve<wbr>Max<wbr>Api<wbr>Version</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:193</li>
<li>Defined in connection.ts:194</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -2827,7 +2829,7 @@ <h3>set<wbr>Api<wbr>Version</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:229</li>
<li>Defined in connection.ts:230</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2999,7 +3001,7 @@ <h3>use<wbr>Latest<wbr>Api<wbr>Version</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:207</li>
<li>Defined in connection.ts:208</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3021,7 +3023,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in connection.ts:83</li>
<li>Defined in connection.ts:84</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 33939f1

Please sign in to comment.