Skip to content

Commit

Permalink
Merge pull request #411 from h3poteto/docs
Browse files Browse the repository at this point in the history 
Update documents
  • Loading branch information
@h3poteto
h3poteto authored May 21, 2020
2 parents 740769b + 45589d4 commit 46fd535
Show file tree
Hide file tree
Showing 36 changed files with 1,112 additions and 1,050 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/classes/argumenterror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/megalodon.ts#L1222">src/megalodon.ts:1222</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/megalodon.ts#L1222">src/megalodon.ts:1222</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
260 changes: 130 additions & 130 deletions docs/classes/mastodon.html
View file

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/classes/mastodonapi.client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L41">src/mastodon/api_client.ts:41</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L41">src/mastodon/api_client.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> access<wbr>Token</h3>
<div class="tsd-signature tsd-kind-icon">access<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L37">src/mastodon/api_client.ts:37</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L37">src/mastodon/api_client.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -205,7 +205,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> base<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">base<wbr>Url<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/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L38">src/mastodon/api_client.ts:38</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L38">src/mastodon/api_client.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -215,7 +215,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> cancel<wbr>Token<wbr>So
<div class="tsd-signature tsd-kind-icon">cancel<wbr>Token<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CancelTokenSource</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L40">src/mastodon/api_client.ts:40</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L40">src/mastodon/api_client.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -225,7 +225,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> proxy<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">proxy<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="../globals.html#proxyconfig" class="tsd-signature-type">ProxyConfig</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L41">src/mastodon/api_client.ts:41</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L41">src/mastodon/api_client.ts:41</a></li>
</ul>
</aside>
</section>
Expand All @@ -235,7 +235,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> user<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Agent<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/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L39">src/mastodon/api_client.ts:39</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L39">src/mastodon/api_client.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -245,7 +245,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>SCOPE</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SCOPE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = DEFAULT_SCOPE</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L33">src/mastodon/api_client.ts:33</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L33">src/mastodon/api_client.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -255,7 +255,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>URL</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;https://mastodon.social&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L34">src/mastodon/api_client.ts:34</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L34">src/mastodon/api_client.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -265,7 +265,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> NO_<wbr>REDIRECT</h3>
<div class="tsd-signature tsd-kind-icon">NO_<wbr>REDIRECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = NO_REDIRECT</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L35">src/mastodon/api_client.ts:35</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L35">src/mastodon/api_client.ts:35</a></li>
</ul>
</aside>
</section>
Expand All @@ -283,7 +283,7 @@ <h3>cancel</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mastodonapi.interface.html">Interface</a>.<a href="../interfaces/mastodonapi.interface.html#cancel">cancel</a></p>
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L264">src/mastodon/api_client.ts:264</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L264">src/mastodon/api_client.ts:264</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -306,7 +306,7 @@ <h3>del</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L223">src/mastodon/api_client.ts:223</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L223">src/mastodon/api_client.ts:223</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -351,7 +351,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L67">src/mastodon/api_client.ts:67</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L67">src/mastodon/api_client.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -396,7 +396,7 @@ <h3>patch</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L150">src/mastodon/api_client.ts:150</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L150">src/mastodon/api_client.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -441,7 +441,7 @@ <h3>post</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L191">src/mastodon/api_client.ts:191</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L191">src/mastodon/api_client.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -486,7 +486,7 @@ <h3>put</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L109">src/mastodon/api_client.ts:109</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L109">src/mastodon/api_client.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -531,7 +531,7 @@ <h3>socket</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L302">src/mastodon/api_client.ts:302</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L302">src/mastodon/api_client.ts:302</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -573,7 +573,7 @@ <h3>stream</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mastodonapi.interface.html">Interface</a>.<a href="../interfaces/mastodonapi.interface.html#stream">stream</a></p>
<ul>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/6116e02/src/mastodon/api_client.ts#L276">src/mastodon/api_client.ts:276</a></li>
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/740769b/src/mastodon/api_client.ts#L276">src/mastodon/api_client.ts:276</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 46fd535

Please sign in to comment.