Skip to content

Commit

Permalink
Update README and Reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cayle Sharrock committed Oct 26, 2017
1 parent 2ad179b commit d32622f
Show file tree
Hide file tree
Showing 271 changed files with 3,288 additions and 1,950 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![CircleCI](https://circleci.com/gh/coinbase/gdax-tt.svg?style=svg)](https://circleci.com/gh/coinbase/gdax-tt)
<!-- ⛔️ AUTO-GENERATED-CONTENT:START (VERSIONBADGE) -->
[![npm](https://img.shields.io/badge/npm-v0.1.21-green.svg)](https://www.npmjs.com/package/gdax-trading-toolkit)
[![npm](https://img.shields.io/badge/npm-v0.1.23-green.svg)](https://www.npmjs.com/package/gdax-trading-toolkit)
<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->

Provide all the tools traders need, both professional and hobbyist alike, to create automated trading bots on the
Expand Down Expand Up @@ -41,7 +41,7 @@ software.
<!-- ⛔️ AUTO-GENERATED-CONTENT:START (CONTRIBUTORS) -->
| **Commits** | **Contributor** |
| --- | --- |
| 27 | [CjS77](https://github.com/CjS77) |
| 32 | [CjS77](https://github.com/CjS77) |
| 4 | [mihar](https://github.com/mihar) |
| 3 | [balupton](https://github.com/balupton) |
| 2 | [kostola](https://github.com/kostola) |
Expand Down
2 changes: 1 addition & 1 deletion docs/apiref/assets/js/search.js
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/apiref/classes/_src_core_exchangeratefilter_.exchangeratefilter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -200,7 +200,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> fx<wbr>Service</h3>
<div class="tsd-signature tsd-kind-icon">fx<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="_src_fxservice_fxservice_.fxservice.html" class="tsd-signature-type">FXService</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L40">src/core/ExchangeRateFilter.ts:40</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L40">src/core/ExchangeRateFilter.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -211,7 +211,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#logger">logger</a></p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/lib/AbstractMessageTransform.ts#L29">src/lib/AbstractMessageTransform.ts:29</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/lib/AbstractMessageTransform.ts#L29">src/lib/AbstractMessageTransform.ts:29</a></li>
</ul>
</aside>
</section>
Expand All @@ -221,7 +221,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> pair</h3>
<div class="tsd-signature tsd-kind-icon">pair<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_src_fxservice_fxprovider_.currencypair.html" class="tsd-signature-type">CurrencyPair</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L39">src/core/ExchangeRateFilter.ts:39</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L39">src/core/ExchangeRateFilter.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -231,7 +231,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> pair<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">pair<wbr>Index<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/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L38">src/core/ExchangeRateFilter.ts:38</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L38">src/core/ExchangeRateFilter.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -241,7 +241,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> precision</h3>
<div class="tsd-signature tsd-kind-icon">precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -302,7 +302,7 @@ <h3>rate</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L51">src/core/ExchangeRateFilter.ts:51</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L51">src/core/ExchangeRateFilter.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_src_fxservice_fxprovider_.fxobject.html" class="tsd-signature-type">FXObject</a></h4>
Expand Down Expand Up @@ -348,7 +348,7 @@ <h3>_transform</h3>
<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#_transform">_transform</a></p>
<p>Overrides Transform._transform</p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/lib/AbstractMessageTransform.ts#L47">src/lib/AbstractMessageTransform.ts:47</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/lib/AbstractMessageTransform.ts#L47">src/lib/AbstractMessageTransform.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -426,7 +426,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> apply<wbr>Rate</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L82">src/core/ExchangeRateFilter.ts:82</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L82">src/core/ExchangeRateFilter.ts:82</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -625,7 +625,7 @@ <h3>log</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#log">log</a></p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/lib/AbstractMessageTransform.ts#L36">src/lib/AbstractMessageTransform.ts:36</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/lib/AbstractMessageTransform.ts#L36">src/lib/AbstractMessageTransform.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -851,7 +851,7 @@ <h3>read</h3>
<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#read">read</a></p>
<p>Overrides Transform.read</p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/lib/AbstractMessageTransform.ts#L43">src/lib/AbstractMessageTransform.ts:43</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/lib/AbstractMessageTransform.ts#L43">src/lib/AbstractMessageTransform.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -995,7 +995,7 @@ <h3>transform<wbr>Message</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#transformmessage">transformMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/1ef9678/src/core/ExchangeRateFilter.ts#L67">src/core/ExchangeRateFilter.ts:67</a></li>
<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/2ad179b/src/core/ExchangeRateFilter.ts#L67">src/core/ExchangeRateFilter.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

0 comments on commit d32622f

Please sign in to comment.