Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Bjornskjald committed May 30, 2019
1 parent 04ed8ef commit 59928b0
Show file tree
Hide file tree
Showing 61 changed files with 1,204 additions and 679 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/apierror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L18">types/Errors.ts:18</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L18">types/Errors.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -137,7 +137,7 @@ <h3>details</h3>
<div class="tsd-signature tsd-kind-icon">details<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L18">types/Errors.ts:18</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L18">types/Errors.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -148,7 +148,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from Error.message</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:964</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964</li>
</ul>
</aside>
</section>
Expand All @@ -159,7 +159,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from Error.name</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:963</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963</li>
</ul>
</aside>
</section>
Expand All @@ -171,7 +171,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<p>Inherited from Error.stack</p>
<p>Overrides Error.stack</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:965</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965</li>
</ul>
</aside>
</section>
Expand All @@ -181,7 +181,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:974</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974</li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/attachmentnotfounderror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L25">types/Errors.ts:25</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L25">types/Errors.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -135,7 +135,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from Error.message</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:964</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from Error.name</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:963</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963</li>
</ul>
</aside>
</section>
Expand All @@ -156,7 +156,7 @@ <h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<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/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L25">types/Errors.ts:25</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L25">types/Errors.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +168,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<p>Inherited from Error.stack</p>
<p>Overrides Error.stack</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:965</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965</li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:974</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974</li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/attachmenturlmissingerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L32">types/Errors.ts:32</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L32">types/Errors.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -134,7 +134,7 @@ <h3>attachment</h3>
<div class="tsd-signature tsd-kind-icon">attachment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L32">types/Errors.ts:32</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L32">types/Errors.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -145,7 +145,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from Error.message</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:964</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964</li>
</ul>
</aside>
</section>
Expand All @@ -156,7 +156,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from Error.name</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:963</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963</li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +168,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<p>Inherited from Error.stack</p>
<p>Overrides Error.stack</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:965</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965</li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:974</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974</li>
</ul>
</aside>
</section>
Expand Down
14 changes: 7 additions & 7 deletions docs/classes/authapierror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> code</h3>
<div class="tsd-signature tsd-kind-icon">code<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/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L2">types/Errors.ts:2</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L2">types/Errors.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -114,7 +114,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">error<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L3">types/Errors.ts:3</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L3">types/Errors.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -125,7 +125,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from Error.message</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:964</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964</li>
</ul>
</aside>
</section>
Expand All @@ -136,7 +136,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from Error.name</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:963</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChatPlug/libfb-js/blob/1c14d47/src/types/Errors.ts#L4">types/Errors.ts:4</a></li>
<li>Defined in <a href="https://github.com/Nordskog/libfb-js/blob/659ffb4/src/types/Errors.ts#L4">types/Errors.ts:4</a></li>
</ul>
</aside>
</section>
Expand All @@ -158,7 +158,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<p>Inherited from Error.stack</p>
<p>Overrides Error.stack</p>
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:965</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965</li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +168,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typescript/lib/lib.es5.d.ts:974</li>
<li>Defined in /Users/bjornskjald/Projekty/JavaScript/libfb-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974</li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 59928b0

Please sign in to comment.