Skip to content

Commit 2175ff6

Browse files
author
Christoph Bühler
committed
docs(api): update documentation
1 parent 3fcea16 commit 2175ff6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+412
-433
lines changed

‎docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/allexport.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h3>constructor</h3>
130130
<li class="tsd-description">
131131
<aside class="tsd-sources">
132132
<ul>
133-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L10">exports/AllExport.ts:10</a></li>
133+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L10">exports/AllExport.ts:10</a></li>
134134
</ul>
135135
</aside>
136136
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +159,7 @@ <h3>end</h3>
159159
<aside class="tsd-sources">
160160
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#end">end</a></p>
161161
<ul>
162-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
162+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
163163
</ul>
164164
</aside>
165165
</section>
@@ -169,7 +169,7 @@ <h3>from</h3>
169169
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
170170
<aside class="tsd-sources">
171171
<ul>
172-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
172+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
173173
</ul>
174174
</aside>
175175
</section>
@@ -180,7 +180,7 @@ <h3>start</h3>
180180
<aside class="tsd-sources">
181181
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#start">start</a></p>
182182
<ul>
183-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
183+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
184184
</ul>
185185
</aside>
186186
</section>

‎docs/classes/assignedexport.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h3>constructor</h3>
137137
<li class="tsd-description">
138138
<aside class="tsd-sources">
139139
<ul>
140-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L33">exports/AssignedExport.ts:33</a></li>
140+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L33">exports/AssignedExport.ts:33</a></li>
141141
</ul>
142142
</aside>
143143
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -168,7 +168,7 @@ <h3>declaration<wbr>Identifier</h3>
168168
<div class="tsd-signature tsd-kind-icon">declaration<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
169169
<aside class="tsd-sources">
170170
<ul>
171-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L38">exports/AssignedExport.ts:38</a></li>
171+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L38">exports/AssignedExport.ts:38</a></li>
172172
</ul>
173173
</aside>
174174
</section>
@@ -179,7 +179,7 @@ <h3>end</h3>
179179
<aside class="tsd-sources">
180180
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#end">end</a></p>
181181
<ul>
182-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L37">exports/AssignedExport.ts:37</a></li>
182+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L37">exports/AssignedExport.ts:37</a></li>
183183
</ul>
184184
</aside>
185185
</section>
@@ -189,7 +189,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> resource</h3>
189189
<div class="tsd-signature tsd-kind-icon">resource<span class="tsd-signature-symbol">:</span> <a href="../interfaces/resource.html" class="tsd-signature-type">Resource</a></div>
190190
<aside class="tsd-sources">
191191
<ul>
192-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L39">exports/AssignedExport.ts:39</a></li>
192+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L39">exports/AssignedExport.ts:39</a></li>
193193
</ul>
194194
</aside>
195195
</section>
@@ -200,7 +200,7 @@ <h3>start</h3>
200200
<aside class="tsd-sources">
201201
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#start">start</a></p>
202202
<ul>
203-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L36">exports/AssignedExport.ts:36</a></li>
203+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L36">exports/AssignedExport.ts:36</a></li>
204204
</ul>
205205
</aside>
206206
</section>
@@ -217,7 +217,7 @@ <h3>exported</h3>
217217
<li class="tsd-description">
218218
<aside class="tsd-sources">
219219
<ul>
220-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L24">exports/AssignedExport.ts:24</a></li>
220+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L24">exports/AssignedExport.ts:24</a></li>
221221
</ul>
222222
</aside>
223223
<div class="tsd-comment tsd-typography">

‎docs/classes/classdeclaration.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h3>constructor</h3>
143143
<li class="tsd-description">
144144
<aside class="tsd-sources">
145145
<ul>
146-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
146+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
147147
</ul>
148148
</aside>
149149
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -174,7 +174,7 @@ <h3>ctor</h3>
174174
<div class="tsd-signature tsd-kind-icon">ctor<span class="tsd-signature-symbol">:</span> <a href="constructordeclaration.html" class="tsd-signature-type">ConstructorDeclaration</a></div>
175175
<aside class="tsd-sources">
176176
<ul>
177-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L16">declarations/ClassDeclaration.ts:16</a></li>
177+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L16">declarations/ClassDeclaration.ts:16</a></li>
178178
</ul>
179179
</aside>
180180
</section>
@@ -185,7 +185,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> end</h3>
185185
<aside class="tsd-sources">
186186
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#end">end</a></p>
187187
<ul>
188-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L25">declarations/ClassDeclaration.ts:25</a></li>
188+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L25">declarations/ClassDeclaration.ts:25</a></li>
189189
</ul>
190190
</aside>
191191
</section>
@@ -196,7 +196,7 @@ <h3>is<wbr>Exported</h3>
196196
<aside class="tsd-sources">
197197
<p>Implementation of <a href="../interfaces/exportabledeclaration.html">ExportableDeclaration</a>.<a href="../interfaces/exportabledeclaration.html#isexported">isExported</a></p>
198198
<ul>
199-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L23">declarations/ClassDeclaration.ts:23</a></li>
199+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L23">declarations/ClassDeclaration.ts:23</a></li>
200200
</ul>
201201
</aside>
202202
</section>
@@ -207,7 +207,7 @@ <h3>methods</h3>
207207
<aside class="tsd-sources">
208208
<p>Implementation of <a href="../interfaces/classlikedeclaration.html">ClassLikeDeclaration</a>.<a href="../interfaces/classlikedeclaration.html#methods">methods</a></p>
209209
<ul>
210-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L18">declarations/ClassDeclaration.ts:18</a></li>
210+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L18">declarations/ClassDeclaration.ts:18</a></li>
211211
</ul>
212212
</aside>
213213
</section>
@@ -218,7 +218,7 @@ <h3>name</h3>
218218
<aside class="tsd-sources">
219219
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#name">name</a></p>
220220
<ul>
221-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L22">declarations/ClassDeclaration.ts:22</a></li>
221+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L22">declarations/ClassDeclaration.ts:22</a></li>
222222
</ul>
223223
</aside>
224224
</section>
@@ -229,7 +229,7 @@ <h3>properties</h3>
229229
<aside class="tsd-sources">
230230
<p>Implementation of <a href="../interfaces/classlikedeclaration.html">ClassLikeDeclaration</a>.<a href="../interfaces/classlikedeclaration.html#properties">properties</a></p>
231231
<ul>
232-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L17">declarations/ClassDeclaration.ts:17</a></li>
232+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L17">declarations/ClassDeclaration.ts:17</a></li>
233233
</ul>
234234
</aside>
235235
</section>
@@ -240,7 +240,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> start</h3>
240240
<aside class="tsd-sources">
241241
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#start">start</a></p>
242242
<ul>
243-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L24">declarations/ClassDeclaration.ts:24</a></li>
243+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L24">declarations/ClassDeclaration.ts:24</a></li>
244244
</ul>
245245
</aside>
246246
</section>
@@ -251,7 +251,7 @@ <h3>type<wbr>Parameters</h3>
251251
<aside class="tsd-sources">
252252
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#typeparameters">typeParameters</a></p>
253253
<ul>
254-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
254+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
255255
</ul>
256256
</aside>
257257
</section>

‎docs/classes/constructordeclaration.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ <h3>constructor</h3>
132132
<li class="tsd-description">
133133
<aside class="tsd-sources">
134134
<ul>
135-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
135+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
136136
</ul>
137137
</aside>
138138
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -161,7 +161,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> end</h3>
161161
<aside class="tsd-sources">
162162
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#end">end</a></p>
163163
<ul>
164-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L19">declarations/ConstructorDeclaration.ts:19</a></li>
164+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L19">declarations/ConstructorDeclaration.ts:19</a></li>
165165
</ul>
166166
</aside>
167167
</section>
@@ -172,7 +172,7 @@ <h3>name</h3>
172172
<aside class="tsd-sources">
173173
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#name">name</a></p>
174174
<ul>
175-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L17">declarations/ConstructorDeclaration.ts:17</a></li>
175+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L17">declarations/ConstructorDeclaration.ts:17</a></li>
176176
</ul>
177177
</aside>
178178
</section>
@@ -183,7 +183,7 @@ <h3>parameters</h3>
183183
<aside class="tsd-sources">
184184
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#parameters">parameters</a></p>
185185
<ul>
186-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L13">declarations/ConstructorDeclaration.ts:13</a></li>
186+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L13">declarations/ConstructorDeclaration.ts:13</a></li>
187187
</ul>
188188
</aside>
189189
</section>
@@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> start</h3>
194194
<aside class="tsd-sources">
195195
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#start">start</a></p>
196196
<ul>
197-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L18">declarations/ConstructorDeclaration.ts:18</a></li>
197+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L18">declarations/ConstructorDeclaration.ts:18</a></li>
198198
</ul>
199199
</aside>
200200
</section>
@@ -205,7 +205,7 @@ <h3>variables</h3>
205205
<aside class="tsd-sources">
206206
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#variables">variables</a></p>
207207
<ul>
208-
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
208+
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
209209
</ul>
210210
</aside>
211211
</section>

0 commit comments

Comments
 (0)