-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
478 lines (474 loc) · 49.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>extra-build</title><meta name="description" content="Documentation for extra-build"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base=".">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">extra-build</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-content">
<div class="tsd-page-title">
<h2>extra-build</h2></div>
<div class="tsd-panel tsd-typography"><p>Common build tools for extra-* packages.<br>
📦 <a href="https://www.npmjs.com/package/extra-build">Node.js</a>,
📜 <a href="https://unpkg.com/extra-build/">Files</a>,
📰 <a href="https://nodef.github.io/extra-build/">Docs</a>.</p>
<p><strong>Why</strong> do packages need to be <strong>built</strong>? For <a href="https://www.typescriptlang.org">TypeScript</a>-based source
libraries (such as this) our main priority is to <strong>generate JavaScript file(s)</strong>
which can be imported from the runtime (<a href="https://nodejs.org/en/">Node.js</a>), and <strong>publish</strong> them to a
<strong>package registry</strong> such as <a href="https://www.npmjs.com">NPM</a>. In addition we might like to generate
associated <a href="https://www.typescriptlang.org/docs/handbook/2/type-declarations.html">type declarations</a> (<code>.d.ts</code> file), which is one of the reasons
behind choosing to write in TypeScript. We might also like to <strong>bundle</strong> all
scripts (and type declarations) into a single file to help reduce package size,
dependencies, or eliminate unused code.</p>
<p><strong>Documentation</strong> plays a key role in reducing the amount of time spent on
<a href="https://stackoverflow.com">Stack Overflow</a>, and thus must be maintained at all costs. Instead of manually
updating it, most developers choose to <strong>generate</strong> this from <strong>documentation</strong>
<strong>comments</strong> in the code. An <code>Index</code> can be added to the <code>README</code> file that
<strong>links to documention</strong>. Thus we have a new build step. In addition, we might
like to <strong>update package metadata</strong> (in <code>package.json</code> or <em>GitHub repo</em>), build
source files for <strong>another platform</strong> (such as the <em>web</em>), <strong>update package</strong>
<strong>version</strong> automatically, <strong>generate wiki files</strong> (for code examples), or
<strong>publish</strong> to <a href="https://github.com/features/packages">GitHub packages</a>.</p>
<p>This package provides utility functions for all of these operations, and more.
The previous version of this package provided a <a href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a> for all of these
operations, but was inflexible in its design (it could only be used when the
source code was arranged is a very specific way). This redesigned version
provides a <strong>JavaScipt API</strong> instead that allows for <strong>significant</strong>
<strong>customization</strong>, in addition to providing a number of helper functions commonly
used in build steps. Build steps can be written in a script file, say
<code>build.js</code>, and executed on a <em>CI system</em> such as <a href="https://github.com/features/actions">GitHub Actions</a> using
<code>.github/workflows/*.yml</code>.</p>
<p>Standalone <strong>symbol name</strong> of a package, such as <code>@package/submodule</code>, can be
obtained with <a href="https://nodef.github.io/extra-build/functions/symbolname.html">symbolname</a> (i.e., <code>package_submodule</code>). This is necessary when
<em>webifying</em> (making it accessible with a <code>script</code> tag) a package. <strong>Keyword</strong>
<strong>name</strong> for an identifier can be procured with <a href="https://nodef.github.io/extra-build/functions/keywordname.html">keywordname</a>, which can then be
used to set the <em>keywords of a package</em> in the <em>metadata file</em> <code>package.json</code>.</p>
<p><strong>Logging</strong> of <em>error</em>, <em>warning</em>, <em>log</em>, and <em>info</em> messages with <em>colors</em> is
provided with <a href="https://nodef.github.io/extra-build/functions/error.html">error</a>, <a href="https://nodef.github.io/extra-build/functions/warn.html">warn</a>, <a href="https://nodef.github.io/extra-build/functions/log.html">log</a>, and <a href="https://nodef.github.io/extra-build/functions/info.html">info</a> respectively. A <em>shell command</em>
can be executed (displaying the command and its output) with <a href="https://nodef.github.io/extra-build/functions/exec.html">exec</a>. The
<em>output</em> of a command can be obtained as a <code>string</code> with <a href="https://nodef.github.io/extra-build/functions/execStr.html">execStr</a>.
Reading/writing of <em>text/JSON</em> files is possible with convenience methods
<a href="https://nodef.github.io/extra-build/functions/readFileText.html">readFileText</a>, <a href="https://nodef.github.io/extra-build/functions/writeFileText.html">writeFileText</a>, <a href="https://nodef.github.io/extra-build/functions/readJson.html">readJson</a>, and <a href="https://nodef.github.io/extra-build/functions/writeJson.html">writeJson</a>. To save the
<em>status</em> and <em>contents</em> of a file (<em>without</em> having to do any <em>existence check</em>)
is possible with <a href="https://nodef.github.io/extra-build/functions/readDocument.html">readDocument</a> and <a href="https://nodef.github.io/extra-build/functions/writeDocument.html">writeDocument</a>. They are useful when it is
required to update a file <em>temporarily</em> and <em>restore</em> it later (if it exists, or
remove if it did not exist).</p>
<p>Helper <code>git</code> commands for <em>commit+push</em>, and setting up a <em>new branch</em> and
<em>pushing</em> <em>to remote</em> (for <code>gh-pages</code>) is available as <a href="https://nodef.github.io/extra-build/functions/gitCommitPush.html">gitCommitPush</a> and
<a href="https://nodef.github.io/extra-build/functions/gitSetupBranch.html">gitSetupBranch</a>. A JavaScript file can be <em>bundled</em> (to a single file) with
<a href="https://nodef.github.io/extra-build/functions/bundleScript.html">bundleScript</a>, and <em>webified</em> (for access on the web) with <a href="https://nodef.github.io/extra-build/functions/webifyScript.html">webifyScript</a>. A
<em>banner</em> can be added to the generated script with <a href="https://nodef.github.io/extra-build/functions/addBanner.html">addBanner</a>. To parse a
<em>GitHub URL</em> (for example from the <code>repository.url</code> field in <code>package.json</code>)
<a href="https://nodef.github.io/extra-build/functions/parseGithubUrl.html">parseGithubUrl</a> can be used. <em>GitHub repository</em> <em>details</em> can be updated (by
default from <code>package.json</code>) with <a href="https://nodef.github.io/extra-build/functions/updateGithubRepoDetails.html">updateGithubRepoDetails</a>.</p>
<p>The <em>metadata file</em> of a package (<code>package.json</code>) can be read/written with
<a href="https://nodef.github.io/extra-build/functions/readMetadata.html">readMetadata</a> and <a href="https://nodef.github.io/extra-build/functions/writeMetadata.html">writeMetadata</a> respectively. The <em>current registry</em> being
used for publishing to <em>NPM</em> (in <code>.npmrc</code> file) can be obtained with <a href="https://nodef.github.io/extra-build/functions/registry.html">registry</a>,
and modified with <a href="https://nodef.github.io/extra-build/functions/setRegistry.html">setRegistry</a>. The <em>latest version</em> of a package can be
obtained with <a href="https://nodef.github.io/extra-build/functions/latestVersion.html">latestVersion</a>, and the <em>next unpublished version</em> (based on the
latest package version, and the <code>version</code> mentioned in <code>package.json</code>) can be
obtained with <a href="https://nodef.github.io/extra-build/functions/nextUnpublishedVersion.html">nextUnpublishedVersion</a>.</p>
<p><strong>JsDoc</strong> for a package can be <em>generated</em> with <a href="https://nodef.github.io/extra-build/functions/generateDocs.html">generateDocs</a>, and published
with <a href="https://nodef.github.io/extra-build/functions/publishDocs.html">publishDocs</a>. <strong>Reflection information</strong> of <em>docs</em> can be obtained from
the <em>source file</em> (through <code>typedoc</code>) with <a href="https://nodef.github.io/extra-build/functions/loadDocs.html">loadDocs</a>. This can then used to
obtain detailed information on <em>exported</em> <em>symbols</em> using <a href="https://nodef.github.io/extra-build/functions/docsName.html">docsName</a>,
<a href="https://nodef.github.io/extra-build/functions/docsLocation.html">docsLocation</a>, <a href="https://nodef.github.io/extra-build/functions/docsFlags.html">docsFlags</a>, <a href="https://nodef.github.io/extra-build/functions/docsKind.html">docsKind</a>, <a href="https://nodef.github.io/extra-build/functions/docsChildCount.html">docsChildCount</a>, <a href="https://nodef.github.io/extra-build/functions/docsParameterCount.html">docsParameterCount</a>,
<a href="https://nodef.github.io/extra-build/functions/docsSignatureCount.html">docsSignatureCount</a>, <a href="https://nodef.github.io/extra-build/functions/docsType.html">docsType</a>, <a href="https://nodef.github.io/extra-build/functions/docsDescription.html">docsDescription</a>, and <a href="https://nodef.github.io/extra-build/functions/docsReturns.html">docsReturns</a>. For
<em>reference symbols</em>, the <em>referred to</em> <em>symbol</em> (which has all the type
information) can be obtained with <a href="https://nodef.github.io/extra-build/functions/docsRefer.html">docsRefer</a>. <em>Simplified details</em> of a
<em>reflection (symbol)</em> can be obtained with <a href="https://nodef.github.io/extra-build/functions/docsDetails.html">docsDetails</a> and <a href="https://nodef.github.io/extra-build/functions/docsReferDetails.html">docsReferDetails</a>
(get details of <em>referred to symbol</em>).</p>
<p><em>Reference code block</em> for <code>wiki</code> can be generated with <a href="https://nodef.github.io/extra-build/functions/wikiCodeReference.html">wikiCodeReference</a>,
<em>example code block</em> can be generated with <a href="https://nodef.github.io/extra-build/functions/wikiCodeExample.html">wikiCodeExample</a>, and <em>full</em>
<em>markdown text</em> can be generated with <a href="https://nodef.github.io/extra-build/functions/wikiMarkdown.html">wikiMarkdown</a>. The <em>"Index"</em> table of
<code>wiki</code> or <code>README.md</code> can be updated (using <em>simplified details of exported</em>
<em>symbols</em>) with <a href="https://nodef.github.io/extra-build/functions/wikiUpdateIndex.html">wikiUpdateIndex</a>, and <em>link references</em> (named links in
markdown) can be updated with <a href="https://nodef.github.io/extra-build/functions/wikiUpdateLinkReferences.html">wikiUpdateLinkReferences</a>. Finally a package can
be published to <em>NPM</em> with <a href="https://nodef.github.io/extra-build/functions/publish.html">publish</a>, and to <em>GitHub</em> with <a href="https://nodef.github.io/extra-build/functions/publishGithub.html">publishGithub</a>.</p>
<p>Behind the dial, these are the gears that make this package tick. TypeScript is
compiled with <a href="https://www.npmjs.com/package/typescript">tsc</a>, bundled with <a href="https://www.npmjs.com/package/rollup">rollup</a>, webified with <a href="https://www.npmjs.com/package/browserify">browserify</a> and
<a href="https://www.npmjs.com/package/terser">terser</a>. Documentation is generated with <a href="https://www.npmjs.com/package/typedoc">typedoc</a>, which is also used to
obtain <code>DocsDetails</code> in order to update index table in <code>README</code> using
<a href="https://www.npmjs.com/package/extra-markdown-text">extra-markdown-text</a>, generate wiki files, and update package metadata locally
and on <em>GitHub</em> repo using <a href="https://www.npmjs.com/package/@octokit/rest">@octokit/rest</a>. Updating of package versions is
achieved with <a href="https://docs.npmjs.com/cli/v7/commands/npm-view">npm view</a> and <a href="https://www.npmjs.com/package/semver">semver</a>. To spice up the console with colors,
<a href="https://www.npmjs.com/package/kleur">kleur</a> is used.</p>
<p>The <strong>goals</strong> for the future include generating example file for <a href="https://runkit.com/home">RunKit</a>,
linking wiki from JsDoc, and duplicating example code from wiki to JsDoc. Did
you find a bug? Or have a feature request?</p>
<blockquote>
<p>Stability: <a href="https://www.youtube.com/watch?v=L1j93RnIxEo">Experimental</a>.</p>
</blockquote>
<br>
<pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">xbuild</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">'extra-build'</span><span class="hl-1">);</span><br/><br/><br/><span class="hl-5">// 1. Set version and publish package.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">m</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-5">// → {name, version, description, ...}</span><br/><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">version</span><span class="hl-1"> = </span><span class="hl-4">'2.0.0'</span><span class="hl-1">;</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-6">m</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">publish</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">publishGithub</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-4">'owner'</span><span class="hl-1">);</span><br/><br/><br/><span class="hl-5">// 2. Publish next version, update github details.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">m</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">ver</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">nextUnpublishedVersion</span><span class="hl-1">(</span><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">name</span><span class="hl-1">, </span><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">version</span><span class="hl-1">);</span><br/><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">version</span><span class="hl-1"> = </span><span class="hl-6">ver</span><span class="hl-1">;</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-6">m</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">publish</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">publishGithub</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-4">'owner'</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">updateGithubRepoDetails</span><span class="hl-1">();</span><br/><br/><br/><span class="hl-5">// 3. Update keywords for package.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">m</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">p</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">loadDocs</span><span class="hl-1">([</span><span class="hl-4">'src/index.ts'</span><span class="hl-1">]);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">ds</span><span class="hl-1"> = </span><span class="hl-6">p</span><span class="hl-1">.</span><span class="hl-6">children</span><span class="hl-1">.</span><span class="hl-3">map</span><span class="hl-1">(</span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-6">docsDetails</span><span class="hl-1">);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">s</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Set</span><span class="hl-1">([...</span><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">keywords</span><span class="hl-1">, ...</span><span class="hl-6">ds</span><span class="hl-1">.</span><span class="hl-3">map</span><span class="hl-1">(</span><span class="hl-6">d</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-6">d</span><span class="hl-1">.</span><span class="hl-6">name</span><span class="hl-1">)]);</span><br/><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">keywords</span><span class="hl-1"> = </span><span class="hl-6">Array</span><span class="hl-1">.</span><span class="hl-3">from</span><span class="hl-1">(</span><span class="hl-6">s</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-6">m</span><span class="hl-1">);</span><br/><br/><br/><span class="hl-5">// 4. Restore package.json after publishing with updated version.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">_package</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readDocument</span><span class="hl-1">(</span><span class="hl-4">'package.json'</span><span class="hl-1">);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">m</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-6">m</span><span class="hl-1">.</span><span class="hl-6">version</span><span class="hl-1"> = </span><span class="hl-4">'2.0.0'</span><span class="hl-1">;</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeMetadata</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">, </span><span class="hl-6">m</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">publish</span><span class="hl-1">(</span><span class="hl-4">'.'</span><span class="hl-1">);</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeDocument</span><span class="hl-1">(</span><span class="hl-6">_package</span><span class="hl-1">);</span><br/><br/><br/><span class="hl-5">// 5. Update README index table.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">owner</span><span class="hl-1"> = </span><span class="hl-4">'owner'</span><span class="hl-1">, </span><span class="hl-6">repo</span><span class="hl-1"> = </span><span class="hl-4">'repo'</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">p</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">loadDocs</span><span class="hl-1">([</span><span class="hl-4">'src/index.ts'</span><span class="hl-1">]);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">ds</span><span class="hl-1"> = </span><span class="hl-6">p</span><span class="hl-1">.</span><span class="hl-6">children</span><span class="hl-1">.</span><span class="hl-3">map</span><span class="hl-1">(</span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-6">docsDetails</span><span class="hl-1">);</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">re</span><span class="hl-1"> =</span><span class="hl-7"> /namespace</span><span class="hl-8">|</span><span class="hl-7">function/</span><span class="hl-0">i</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">dm</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Map</span><span class="hl-1">(</span><span class="hl-6">ds</span><span class="hl-1">.</span><span class="hl-3">map</span><span class="hl-1">(</span><span class="hl-6">d</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> [</span><span class="hl-6">d</span><span class="hl-1">.</span><span class="hl-6">name</span><span class="hl-1">, </span><span class="hl-6">d</span><span class="hl-1">]));</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-6">txt</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">readFileText</span><span class="hl-1">(</span><span class="hl-4">'README.md'</span><span class="hl-1">);</span><br/><span class="hl-6">txt</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">wikiUpdateIndex</span><span class="hl-1">(</span><span class="hl-6">txt</span><span class="hl-1">, </span><span class="hl-6">dm</span><span class="hl-1">, </span><span class="hl-6">d</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-6">re</span><span class="hl-1">.</span><span class="hl-3">test</span><span class="hl-1">(</span><span class="hl-6">d</span><span class="hl-1">.</span><span class="hl-6">kind</span><span class="hl-1">));</span><br/><span class="hl-6">txt</span><span class="hl-1"> = </span><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">wikiUpdateLinkReferences</span><span class="hl-1">(</span><span class="hl-6">txt</span><span class="hl-1">, </span><span class="hl-6">dm</span><span class="hl-1">, {</span><span class="hl-6">owner</span><span class="hl-1">, </span><span class="hl-6">repo</span><span class="hl-1">});</span><br/><span class="hl-6">xbuild</span><span class="hl-1">.</span><span class="hl-3">writeFileText</span><span class="hl-1">(</span><span class="hl-4">'README.md'</span><span class="hl-1">, </span><span class="hl-6">txt</span><span class="hl-1">);</span>
</code><button>Copy</button></pre>
<br>
<br>
<a id="md:index" class="tsd-anchor"></a><h2><a href="#md:index">Index</a></h2><table>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://nodef.github.io/extra-build/functions/symbolname.html">symbolname</a></td>
<td>Get symbol name for file.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/keywordname.html">keywordname</a></td>
<td>Get keyword name for file.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/error.html">error</a></td>
<td>Print error message to stderr with newline.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/warn.html">warn</a></td>
<td>Print warning message to stderr with newline.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/log.html">log</a></td>
<td>Print log message to stdout with newline.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/info.html">info</a></td>
<td>Print info message to stdout with newline.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/exec.html">exec</a></td>
<td>Execute command with output, and print the command.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/execStr.html">execStr</a></td>
<td>Execute command and get its output as string.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/readFileText.html">readFileText</a></td>
<td>Read file text with Unix EOL.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/writeFileText.html">writeFileText</a></td>
<td>Write file text with system EOL.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/readJson.html">readJson</a></td>
<td>Read JSON file as object.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/writeJson.html">writeJson</a></td>
<td>Write object to JSON file.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/readDocument.html">readDocument</a></td>
<td>Read document.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/writeDocument.html">writeDocument</a></td>
<td>Write document.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/gitCommitPush.html">gitCommitPush</a></td>
<td>Commit new changes and push to remote.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/gitSetupBranch.html">gitSetupBranch</a></td>
<td>Setup new branch and push to remote.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/addBanner.html">addBanner</a></td>
<td>Add banner (header comment) to script text.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/bundleScript.html">bundleScript</a></td>
<td>Bundle a script file with config.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/webifyScript.html">webifyScript</a></td>
<td>Webify a script file.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/jsdocifyScript.html">jsdocifyScript</a></td>
<td>Transform JSDocs in a script file.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/parseGithubUrl.html">parseGithubUrl</a></td>
<td>Get details from GitHub URL.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/updateGithubRepoDetails.html">updateGithubRepoDetails</a></td>
<td>Update GitHub repository details.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/readMetadata.html">readMetadata</a></td>
<td>Read package.json data.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/writeMetadata.html">writeMetadata</a></td>
<td>Write package.json data.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/registry.html">registry</a></td>
<td>Get current registry.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/setRegistry.html">setRegistry</a></td>
<td>Set current registry.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/latestVersion.html">latestVersion</a></td>
<td>Get latest package version.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/nextUnpublishedVersion.html">nextUnpublishedVersion</a></td>
<td>Get next unpublished version for package.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/publish.html">publish</a></td>
<td>Publish package to NPM.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/publishGithub.html">publishGithub</a></td>
<td>Publish package to GitHub.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/generateDocs.html">generateDocs</a></td>
<td>Generate docs using typedoc.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/publishDocs.html">publishDocs</a></td>
<td>Publish docs to gh-pages.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsRefer.html">docsRefer</a></td>
<td>Get the reflection that is referred to.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsName.html">docsName</a></td>
<td>Get name of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsLocation.html">docsLocation</a></td>
<td>Get location of reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsFlags.html">docsFlags</a></td>
<td>Get flags of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsKind.html">docsKind</a></td>
<td>Get kind name of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsChildCount.html">docsChildCount</a></td>
<td>Get child count of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsParameterCount.html">docsParameterCount</a></td>
<td>Get parameter count of a reflection (function).</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsSignatureCount.html">docsSignatureCount</a></td>
<td>Get signature count of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsType.html">docsType</a></td>
<td>Get type name of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsDescription.html">docsDescription</a></td>
<td>Get description of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsReturns.html">docsReturns</a></td>
<td>Get returns description of a reflection (function).</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsDetails.html">docsDetails</a></td>
<td>Get details of a reflection.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/docsReferDetails.html">docsReferDetails</a></td>
<td>Get details of a reflection, referring the necessary details.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/loadDocs.html">loadDocs</a></td>
<td>Load docs from source file.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiCodeReference.html">wikiCodeReference</a></td>
<td>Generate reference code block for wiki.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiCodeExample.html">wikiCodeExample</a></td>
<td>Generate example code block for wiki.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiMarkdown.html">wikiMarkdown</a></td>
<td>Generate markdown text for wiki.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiUpdateIndex.html">wikiUpdateIndex</a></td>
<td>Update the "Index" (property, description) table in markdown text.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiUpdateLinkReferences.html">wikiUpdateLinkReferences</a></td>
<td>Update link references in markdown text.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiUpdateDescription.html">wikiUpdateDescription</a></td>
<td>Update description in markdown text.</td>
</tr>
<tr>
<td><a href="https://nodef.github.io/extra-build/functions/wikiUpdateCodeReference.html">wikiUpdateCodeReference</a></td>
<td>Update code reference in markdown text.</td>
</tr>
</tbody></table>
<br>
<br>
<p><a href="https://www.youtube.com/watch?v=BCxhQpS5fQ0"><img src="https://img.youtube.com/vi/BCxhQpS5fQ0/maxresdefault.jpg" alt=""></a>
<a href="https://nodef.github.io"><img src="https://img.shields.io/badge/org-nodef-green?logo=Org" alt="ORG"></a>
<a href="https://zenodo.org/badge/latestdoi/254083559"><img src="https://zenodo.org/badge/254083559.svg" alt="DOI"></a></p>
</div></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li>
<ul>
<li><a href="#md:index"><span>Index</span></a></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>extra-<wbr/>build</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="interfaces/BundleOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Bundle<wbr/>Options</span></a></li>
<li><a href="interfaces/DocsDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Docs<wbr/>Details</span></a></li>
<li><a href="interfaces/Document.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Document</span></a></li>
<li><a href="interfaces/ExecOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Exec<wbr/>Options</span></a></li>
<li><a href="interfaces/GitCommitPushOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Git<wbr/>Commit<wbr/>Push<wbr/>Options</span></a></li>
<li><a href="interfaces/GitSetupBranchOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Git<wbr/>Setup<wbr/>Branch<wbr/>Options</span></a></li>
<li><a href="interfaces/GithubRepoDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Github<wbr/>Repo<wbr/>Details</span></a></li>
<li><a href="interfaces/GithubUrlDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Github<wbr/>Url<wbr/>Details</span></a></li>
<li><a href="interfaces/JsdocToken.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Jsdoc<wbr/>Token</span></a></li>
<li><a href="interfaces/MarkdownOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Markdown<wbr/>Options</span></a></li>
<li><a href="interfaces/WebifyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Webify<wbr/>Options</span></a></li>
<li><a href="types/OnDocsDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>On<wbr/>Docs<wbr/>Details</span></a></li>
<li><a href="types/OnJsdocToken.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>On<wbr/>Jsdoc<wbr/>Token</span></a></li>
<li><a href="functions/addBanner.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>add<wbr/>Banner</span></a></li>
<li><a href="functions/bundleScript.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>bundle<wbr/>Script</span></a></li>
<li><a href="functions/docsChildCount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Child<wbr/>Count</span></a></li>
<li><a href="functions/docsDescription.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Description</span></a></li>
<li><a href="functions/docsDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Details</span></a></li>
<li><a href="functions/docsFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Flags</span></a></li>
<li><a href="functions/docsKind.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Kind</span></a></li>
<li><a href="functions/docsLocation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Location</span></a></li>
<li><a href="functions/docsName.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Name</span></a></li>
<li><a href="functions/docsParameterCount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Parameter<wbr/>Count</span></a></li>
<li><a href="functions/docsRefer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Refer</span></a></li>
<li><a href="functions/docsReferDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Refer<wbr/>Details</span></a></li>
<li><a href="functions/docsReturns.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Returns</span></a></li>
<li><a href="functions/docsSignatureCount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Signature<wbr/>Count</span></a></li>
<li><a href="functions/docsType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>docs<wbr/>Type</span></a></li>
<li><a href="functions/error.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>error</span></a></li>
<li><a href="functions/exec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>exec</span></a></li>
<li><a href="functions/execStr.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>exec<wbr/>Str</span></a></li>
<li><a href="functions/generateDocs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>generate<wbr/>Docs</span></a></li>
<li><a href="functions/gitCommitPush.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>git<wbr/>Commit<wbr/>Push</span></a></li>
<li><a href="functions/gitSetupBranch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>git<wbr/>Setup<wbr/>Branch</span></a></li>
<li><a href="functions/info.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>info</span></a></li>
<li><a href="functions/jsdocifyScript.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>jsdocify<wbr/>Script</span></a></li>
<li><a href="functions/keywordname.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>keywordname</span></a></li>
<li><a href="functions/latestVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>latest<wbr/>Version</span></a></li>
<li><a href="functions/loadDocs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>load<wbr/>Docs</span></a></li>
<li><a href="functions/log.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>log</span></a></li>
<li><a href="functions/nextUnpublishedVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>next<wbr/>Unpublished<wbr/>Version</span></a></li>
<li><a href="functions/parseGithubUrl.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Github<wbr/>Url</span></a></li>
<li><a href="functions/publish.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>publish</span></a></li>
<li><a href="functions/publishDocs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>publish<wbr/>Docs</span></a></li>
<li><a href="functions/publishGithub.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>publish<wbr/>Github</span></a></li>
<li><a href="functions/readDocument.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>read<wbr/>Document</span></a></li>
<li><a href="functions/readFileText.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>read<wbr/>File<wbr/>Text</span></a></li>
<li><a href="functions/readJson.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>read<wbr/>Json</span></a></li>
<li><a href="functions/readMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>read<wbr/>Metadata</span></a></li>
<li><a href="functions/registry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>registry</span></a></li>
<li><a href="functions/setRegistry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>set<wbr/>Registry</span></a></li>
<li><a href="functions/symbolname.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>symbolname</span></a></li>
<li><a href="functions/updateGithubRepoDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>update<wbr/>Github<wbr/>Repo<wbr/>Details</span></a></li>
<li><a href="functions/warn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>warn</span></a></li>
<li><a href="functions/webifyScript.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>webify<wbr/>Script</span></a></li>
<li><a href="functions/wikiCodeExample.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Code<wbr/>Example</span></a></li>
<li><a href="functions/wikiCodeReference.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Code<wbr/>Reference</span></a></li>
<li><a href="functions/wikiMarkdown.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Markdown</span></a></li>
<li><a href="functions/wikiUpdateCodeReference.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Update<wbr/>Code<wbr/>Reference</span></a></li>
<li><a href="functions/wikiUpdateDescription.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Update<wbr/>Description</span></a></li>
<li><a href="functions/wikiUpdateIndex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Update<wbr/>Index</span></a></li>
<li><a href="functions/wikiUpdateLinkReferences.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wiki<wbr/>Update<wbr/>Link<wbr/>References</span></a></li>
<li><a href="functions/writeDocument.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>write<wbr/>Document</span></a></li>
<li><a href="functions/writeFileText.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>write<wbr/>File<wbr/>Text</span></a></li>
<li><a href="functions/writeJson.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>write<wbr/>Json</span></a></li>
<li><a href="functions/writeMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>write<wbr/>Metadata</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>