Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@auralia
auralia committed Jan 12, 2017
1 parent e49586c commit 9467dba
Show file tree
Hide file tree
Showing 9 changed files with 342 additions and 77 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

30 changes: 17 additions & 13 deletions docs/classes/apierror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Constructors</h3>
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="apierror.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="apierror.html#responsecode" class="tsd-kind-icon">response<wbr>Code</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="apierror.html#responsemetadata" class="tsd-kind-icon">response<wbr>Metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="apierror.html#responsetext" class="tsd-kind-icon">response<wbr>Text</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="apierror.html#error" class="tsd-kind-icon">Error</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="apierror.html#message-1" class="tsd-kind-icon">message</a></li>
Expand All @@ -118,13 +118,13 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Api<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, responseCode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, responseText<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apierror.html" class="tsd-signature-type">ApiError</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Api<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, responseMetadata<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">IncomingMessage</span>, responseText<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apierror.html" class="tsd-signature-type">ApiError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:131</li>
<li>Defined in api.ts:132</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -143,10 +143,11 @@ <h5>message: <span class="tsd-signature-type">string</span></h5>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> responseCode: <span class="tsd-signature-type">number</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> responseMetadata: <span class="tsd-signature-type">IncomingMessage</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTTP response code returned by the API.</p>
<p>The HTTP response metadata returned by the
NationStates website.</p>
</div>
</div>
</li>
Expand All @@ -172,7 +173,7 @@ <h3>message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:123</li>
<li>Defined in api.ts:124</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,17 +183,17 @@ <h3>message</h3>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="responsecode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Code</h3>
<div class="tsd-signature tsd-kind-icon">response<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<a name="responsemetadata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Metadata</h3>
<div class="tsd-signature tsd-kind-icon">response<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IncomingMessage</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:127</li>
<li>Defined in api.ts:128</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTTP response code returned by the API.</p>
<p>The HTTP response metadata returned by the NationStates website.</p>
</div>
</div>
</section>
Expand All @@ -202,7 +203,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Text</h3
<div class="tsd-signature tsd-kind-icon">response<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:131</li>
<li>Defined in api.ts:132</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -284,7 +285,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
<a href="apierror.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="apierror.html#responsecode" class="tsd-kind-icon">response<wbr>Code</a>
<a href="apierror.html#responsemetadata" class="tsd-kind-icon">response<wbr>Metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="apierror.html#responsetext" class="tsd-kind-icon">response<wbr>Text</a>
Expand All @@ -308,6 +309,9 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
<li class=" tsd-kind-class">
<a href="nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
</li>
Expand Down
Loading

0 comments on commit 9467dba

Please sign in to comment.