[ci skip] Updates
This commit is contained in:
File diff suppressed because one or more lines are too long
@@ -89,7 +89,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_EMAIL"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L11">cli/tasks.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L16">cli/tasks.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -99,7 +99,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_NAME"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L12">cli/tasks.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L17">cli/tasks.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -109,7 +109,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_GITHUB_USER_NAME"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L13">cli/tasks.ts:13</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L18">cli/tasks.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Npm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "npm"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L6">cli/utils.ts:6</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L6">cli/utils.ts:6</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -98,7 +98,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Yarn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "yarn"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L7">cli/utils.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L7">cli/utils.ts:7</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
@@ -92,7 +92,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">five<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-5"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L44">cli/tests/cli.integration.spec.ts:44</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L54">cli/tests/cli.integration.spec.ts:54</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -102,7 +102,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">four<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-4"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L43">cli/tests/cli.integration.spec.ts:43</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L53">cli/tests/cli.integration.spec.ts:53</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -112,7 +112,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">one<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-1"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L40">cli/tests/cli.integration.spec.ts:40</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L50">cli/tests/cli.integration.spec.ts:50</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -122,7 +122,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">six<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-6"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L45">cli/tests/cli.integration.spec.ts:45</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L55">cli/tests/cli.integration.spec.ts:55</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -132,7 +132,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">three<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-3"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L42">cli/tests/cli.integration.spec.ts:42</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L52">cli/tests/cli.integration.spec.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -142,7 +142,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">two<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "test-2"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L41">cli/tests/cli.integration.spec.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L51">cli/tests/cli.integration.spec.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
485
globals.html
485
globals.html
@@ -79,34 +79,43 @@
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/tasks.html" class="tsd-kind-icon">Tasks</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/typescriptstarterclioptions.html" class="tsd-kind-icon">Typescript<wbr>StarterCLIOptions</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/typescriptstarterinferredoptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Inferred<wbr>Options</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/typescriptstarteroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Options</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/typescriptstarteruseroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/typescriptstarterrequiredconfig.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Required<wbr>Config</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#typescriptstarterargsoptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Args<wbr>Options</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#typescriptstarteruseroptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#branch" class="tsd-kind-icon">branch</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#builddir" class="tsd-kind-icon">build<wbr>Dir</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#down" class="tsd-kind-icon">down</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#enter" class="tsd-kind-icon">enter</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#inherit" class="tsd-kind-icon">inherit</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#repourl" class="tsd-kind-icon">repoURL</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#up" class="tsd-kind-icon">up</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function"><a href="globals.html#addinferredoptions" class="tsd-kind-icon">add<wbr>Inferred<wbr>Options</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#asyncabc" class="tsd-kind-icon">asyncABC</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#checkargs" class="tsd-kind-icon">check<wbr>Args</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#clonerepo" class="tsd-kind-icon">clone<wbr>Repo</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#double" class="tsd-kind-icon">double</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getgithubusername" class="tsd-kind-icon">get<wbr>Github<wbr>Username</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getinferredoptions" class="tsd-kind-icon">get<wbr>Inferred<wbr>Options</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getintro" class="tsd-kind-icon">get<wbr>Intro</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getrepourl" class="tsd-kind-icon">get<wbr>Repo<wbr>Url</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getrepoinfo" class="tsd-kind-icon">get<wbr>Repo<wbr>Info</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#getuserinfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#hasclioptions" class="tsd-kind-icon">hasCLIOptions</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#hash" class="tsd-kind-icon">hash</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#hashallthethings" class="tsd-kind-icon">hash<wbr>All<wbr>The<wbr>Things</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#initialcommit" class="tsd-kind-icon">initial<wbr>Commit</a></li>
|
||||
@@ -114,8 +123,8 @@
|
||||
<li class="tsd-kind-function"><a href="globals.html#install" class="tsd-kind-icon">install</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#mockerr" class="tsd-kind-icon">mock<wbr>Err</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#ms" class="tsd-kind-icon">ms</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#passupdatenotifier" class="tsd-kind-icon">pass<wbr>Update<wbr>Notifier</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#power" class="tsd-kind-icon">power</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#pretendlatestversionis" class="tsd-kind-icon">pretend<wbr>Latest<wbr>Version<wbr>Is</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#readpackagejson" class="tsd-kind-icon">read<wbr>Package<wbr>Json</a></li>
|
||||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#sandboxtasks" class="tsd-kind-icon">sandbox<wbr>Tasks</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#sha256" class="tsd-kind-icon">sha256</a></li>
|
||||
@@ -131,63 +140,46 @@
|
||||
<h3>Object literals</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-object-literal"><a href="globals.html#livetasks" class="tsd-kind-icon">Live<wbr>Tasks</a></li>
|
||||
<li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#env" class="tsd-kind-icon">env</a></li>
|
||||
<li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a></li>
|
||||
<li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#sandboxoptions" class="tsd-kind-icon">sandbox<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="typescriptstarterargsoptions" class="tsd-anchor"></a>
|
||||
<h3>Typescript<wbr>Starter<wbr>Args<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>Args<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="globals.html#typescriptstarteruseroptions" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/typescriptstarterrequiredconfig.html" class="tsd-signature-type">TypescriptStarterRequiredConfig</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L30">cli/utils.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="typescriptstarteruseroptions" class="tsd-anchor"></a>
|
||||
<h3>Typescript<wbr>Starter<wbr>User<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="interfaces/typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol"> & </span><a href="interfaces/typescriptstarterrequiredconfig.html" class="tsd-signature-type">TypescriptStarterRequiredConfig</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L27">cli/utils.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="builddir" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> build<wbr>Dir</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">build<wbr>Dir<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = join(process.cwd(), 'build')</span></div>
|
||||
<a name="branch" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> branch</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">branch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = execa.sync('git', ['rev-parse','--symbolic-full-name','--abbrev-ref','HEAD']).stdout</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L37">cli/tests/cli.integration.spec.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="down" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> down</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"[B"</span><span class="tsd-signature-symbol"> = "[B"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L199">cli/tests/cli.integration.spec.ts:199</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="enter" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> enter</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">enter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"
|
||||
"</span><span class="tsd-signature-symbol"> = "
|
||||
"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L201">cli/tests/cli.integration.spec.ts:201</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="inherit" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> inherit</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">inherit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipe"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ipc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ignore"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"> = 'inherit' as StdIOOption</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L8">cli/tasks.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="repourl" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> repoURL</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repoURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.cwd()</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L36">cli/tests/cli.integration.spec.ts:36</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L36">cli/tests/cli.integration.spec.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -199,19 +191,84 @@
|
||||
directory for easier clean up.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="builddir" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> build<wbr>Dir</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">build<wbr>Dir<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = join(process.cwd(), 'build')</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L43">cli/tests/cli.integration.spec.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="down" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> down</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"[B"</span><span class="tsd-signature-symbol"> = "[B"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L205">cli/tests/cli.integration.spec.ts:205</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="enter" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> enter</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">enter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"
|
||||
"</span><span class="tsd-signature-symbol"> = "
|
||||
"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L207">cli/tests/cli.integration.spec.ts:207</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="inherit" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> inherit</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">inherit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipe"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ipc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ignore"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"> = 'inherit' as StdIOOption</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L13">cli/tasks.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="up" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> up</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"[A"</span><span class="tsd-signature-symbol"> = "[A"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L200">cli/tests/cli.integration.spec.ts:200</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L206">cli/tests/cli.integration.spec.ts:206</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="addinferredoptions" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr>Inferred<wbr>Options</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">add<wbr>Inferred<wbr>Options<span class="tsd-signature-symbol">(</span>userOptions<span class="tsd-signature-symbol">: </span><a href="globals.html#typescriptstarteruseroptions" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteroptions.html" class="tsd-signature-type">TypescriptStarterOptions</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L183">cli/tasks.ts:183</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>userOptions: <a href="globals.html#typescriptstarteruseroptions" class="tsd-signature-type">TypescriptStarterUserOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteroptions.html" class="tsd-signature-type">TypescriptStarterOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="asyncabc" class="tsd-anchor"></a>
|
||||
<h3>asyncABC</h3>
|
||||
@@ -222,7 +279,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -249,16 +306,16 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<a name="checkargs" class="tsd-anchor"></a>
|
||||
<h3>check<wbr>Args</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">check<wbr>Args<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteruseroptions.html" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">check<wbr>Args<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/args.ts#L7">cli/args.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/args.ts#L7">cli/args.ts:7</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteruseroptions.html" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -272,7 +329,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L18">cli/tasks.ts:18</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L23">cli/tasks.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -298,7 +355,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -345,7 +402,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L53">cli/tasks.ts:53</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L69">cli/tasks.ts:69</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -358,23 +415,6 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="getinferredoptions" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Inferred<wbr>Options</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Inferred<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarterinferredoptions.html" class="tsd-signature-type">TypescriptStarterInferredOptions</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L150">cli/tasks.ts:150</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarterinferredoptions.html" class="tsd-signature-type">TypescriptStarterInferredOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="getintro" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Intro</h3>
|
||||
@@ -385,7 +425,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L42">cli/utils.ts:42</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L65">cli/utils.ts:65</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -399,19 +439,46 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="getrepourl" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Repo<wbr>Url</h3>
|
||||
<a name="getrepoinfo" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Repo<wbr>Info</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Repo<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Repo<wbr>Info<span class="tsd-signature-symbol">(</span>starterVersion<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><span class="tsd-signature-type">object</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L124">cli/tasks.ts:124</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L147">cli/tasks.ts:147</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the URL and branch to clone. We clone the branch (tag) at the current
|
||||
release rather than <code>master</code>. This ensures we get the exact files expected by
|
||||
this version of the CLI. (If we cloned master, changes merged to master, but
|
||||
not yet released, may cause unexpected results.)</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>starterVersion: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>the current version of this CLI</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -425,7 +492,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L64">cli/tasks.ts:64</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L80">cli/tasks.ts:80</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -438,6 +505,29 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="hasclioptions" class="tsd-anchor"></a>
|
||||
<h3>hasCLIOptions</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">hasCLIOptions<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L51">cli/utils.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>opts: <a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||||
<a name="hash" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> hash</h3>
|
||||
@@ -448,7 +538,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/hash.spec.ts#L5">lib/hash.spec.ts:5</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/hash.spec.ts#L5">lib/hash.spec.ts:5</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -477,7 +567,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L87">cli/tests/cli.integration.spec.ts:87</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L97">cli/tests/cli.integration.spec.ts:97</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -503,7 +593,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L84">cli/tasks.ts:84</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L100">cli/tasks.ts:100</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -520,16 +610,16 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<a name="inquire" class="tsd-anchor"></a>
|
||||
<h3>inquire</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">inquire<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteruseroptions.html" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">inquire<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/inquire.ts#L4">cli/inquire.ts:4</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/inquire.ts#L4">cli/inquire.ts:4</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarteruseroptions.html" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -543,7 +633,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L106">cli/tasks.ts:106</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L122">cli/tasks.ts:122</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -566,7 +656,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.unit.spec.ts#L122">cli/tests/cli.unit.spec.ts:122</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.unit.spec.ts#L125">cli/tests/cli.unit.spec.ts:125</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -589,7 +679,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L202">cli/tests/cli.integration.spec.ts:202</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L208">cli/tests/cli.integration.spec.ts:208</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -602,29 +692,6 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||||
<a name="passupdatenotifier" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> pass<wbr>Update<wbr>Notifier</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">pass<wbr>Update<wbr>Notifier<span class="tsd-signature-symbol">(</span>version<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><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.unit.spec.ts#L35">cli/tests/cli.unit.spec.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>version: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="power" class="tsd-anchor"></a>
|
||||
<h3>power</h3>
|
||||
@@ -635,7 +702,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/number.ts#L43">lib/number.ts:43</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/number.ts#L43">lib/number.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -666,6 +733,29 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||||
<a name="pretendlatestversionis" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> pretend<wbr>Latest<wbr>Version<wbr>Is</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">pretend<wbr>Latest<wbr>Version<wbr>Is<span class="tsd-signature-symbol">(</span>version<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><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.unit.spec.ts#L35">cli/tests/cli.unit.spec.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>version: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||||
<a name="readpackagejson" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> read<wbr>Package<wbr>Json</h3>
|
||||
@@ -676,7 +766,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/typescript-starter.ts#L239">cli/typescript-starter.ts:239</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/typescript-starter.ts#L239">cli/typescript-starter.ts:239</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -699,7 +789,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L335">cli/tests/cli.integration.spec.ts:335</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L339">cli/tests/cli.integration.spec.ts:339</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -728,7 +818,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/hash.ts#L16">lib/hash.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/hash.ts#L16">lib/hash.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -762,7 +852,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/lib/hash.ts#L34">lib/hash.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/lib/hash.ts#L34">lib/hash.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -796,7 +886,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L358">cli/tests/cli.integration.spec.ts:358</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L362">cli/tests/cli.integration.spec.ts:362</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -819,7 +909,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L205">cli/tests/cli.integration.spec.ts:205</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L211">cli/tests/cli.integration.spec.ts:211</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -848,7 +938,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/typescript-starter.ts#L11">cli/typescript-starter.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/typescript-starter.ts#L11">cli/typescript-starter.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -884,7 +974,15 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<h5>project<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repoURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<h5>repo<wbr>Info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>runner<span class="tsd-signature-symbol">: </span><a href="enums/runner.html" class="tsd-signature-type">Runner</a></h5>
|
||||
@@ -918,7 +1016,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L34">cli/utils.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L57">cli/utils.ts:57</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -944,7 +1042,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/typescript-starter.ts#L242">cli/typescript-starter.ts:242</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/typescript-starter.ts#L242">cli/typescript-starter.ts:242</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -969,7 +1067,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">Live<wbr>Tasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L145">cli/tasks.ts:145</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L178">cli/tasks.ts:178</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||||
@@ -978,7 +1076,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">clone<wbr>Repo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = cloneRepo(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L146">cli/tasks.ts:146</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L179">cli/tasks.ts:179</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -988,7 +1086,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">initial<wbr>Commit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = initialCommit(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L147">cli/tasks.ts:147</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L180">cli/tasks.ts:180</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -998,7 +1096,67 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = install(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L148">cli/tasks.ts:148</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L181">cli/tasks.ts:181</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a name="env" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> env</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">env<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L44">cli/tests/cli.integration.spec.ts:44</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="env.typescript_starter_repo_branch" class="tsd-anchor"></a>
|
||||
<h3>TYPESCRIPT_<wbr>STARTER_<wbr>REPO_<wbr>BRANCH</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">TYPESCRIPT_<wbr>STARTER_<wbr>REPO_<wbr>BRANCH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = repoInfo.branch</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L45">cli/tests/cli.integration.spec.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="env.typescript_starter_repo_url" class="tsd-anchor"></a>
|
||||
<h3>TYPESCRIPT_<wbr>STARTER_<wbr>REPO_<wbr>URL</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">TYPESCRIPT_<wbr>STARTER_<wbr>REPO_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = repoInfo.repo</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L46">cli/tests/cli.integration.spec.ts:46</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a name="repoinfo" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> repo<wbr>Info</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repo<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L42">cli/tests/cli.integration.spec.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="repoinfo.branch" class="tsd-anchor"></a>
|
||||
<h3>branch</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">branch<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/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L42">cli/tests/cli.integration.spec.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="repoinfo.repo" class="tsd-anchor"></a>
|
||||
<h3>repo</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.cwd()</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L42">cli/tests/cli.integration.spec.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -1009,7 +1167,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">sandbox<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L351">cli/tests/cli.integration.spec.ts:351</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L355">cli/tests/cli.integration.spec.ts:355</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
@@ -1018,7 +1176,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "this is an example description"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L352">cli/tests/cli.integration.spec.ts:352</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L356">cli/tests/cli.integration.spec.ts:356</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -1028,19 +1186,30 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">github<wbr>Username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "SOME_GITHUB_USERNAME"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L353">cli/tests/cli.integration.spec.ts:353</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L357">cli/tests/cli.integration.spec.ts:357</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="sandboxoptions.repourl" class="tsd-anchor"></a>
|
||||
<h3>repoURL</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repoURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<a name="sandboxoptions.repoinfo" class="tsd-anchor"></a>
|
||||
<h3>repo<wbr>Info</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repo<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L354">cli/tests/cli.integration.spec.ts:354</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L358">cli/tests/cli.integration.spec.ts:358</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||||
<a name="sandboxoptions.workingdirectory" class="tsd-anchor"></a>
|
||||
@@ -1048,7 +1217,7 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<div class="tsd-signature tsd-kind-icon">working<wbr>Directory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = buildDir</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tests/cli.integration.spec.ts#L355">cli/tests/cli.integration.spec.ts:355</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tests/cli.integration.spec.ts#L359">cli/tests/cli.integration.spec.ts:359</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -1077,6 +1246,9 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/tasks.html" class="tsd-kind-icon">Tasks</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarterclioptions.html" class="tsd-kind-icon">Typescript<wbr>StarterCLIOptions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarterinferredoptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
@@ -1084,7 +1256,16 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<a href="interfaces/typescriptstarteroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarteruseroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a>
|
||||
<a href="interfaces/typescriptstarterrequiredconfig.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Required<wbr>Config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#typescriptstarterargsoptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Args<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#typescriptstarteruseroptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#branch" class="tsd-kind-icon">branch</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#builddir" class="tsd-kind-icon">build<wbr>Dir</a>
|
||||
@@ -1098,12 +1279,12 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#inherit" class="tsd-kind-icon">inherit</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#repourl" class="tsd-kind-icon">repoURL</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#up" class="tsd-kind-icon">up</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#addinferredoptions" class="tsd-kind-icon">add<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#asyncabc" class="tsd-kind-icon">asyncABC</a>
|
||||
</li>
|
||||
@@ -1119,18 +1300,18 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getgithubusername" class="tsd-kind-icon">get<wbr>Github<wbr>Username</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getinferredoptions" class="tsd-kind-icon">get<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getintro" class="tsd-kind-icon">get<wbr>Intro</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getrepourl" class="tsd-kind-icon">get<wbr>Repo<wbr>Url</a>
|
||||
<a href="globals.html#getrepoinfo" class="tsd-kind-icon">get<wbr>Repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getuserinfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#hasclioptions" class="tsd-kind-icon">hasCLIOptions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#hash" class="tsd-kind-icon">hash</a>
|
||||
</li>
|
||||
@@ -1152,12 +1333,12 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#ms" class="tsd-kind-icon">ms</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#passupdatenotifier" class="tsd-kind-icon">pass<wbr>Update<wbr>Notifier</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#power" class="tsd-kind-icon">power</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#pretendlatestversionis" class="tsd-kind-icon">pretend<wbr>Latest<wbr>Version<wbr>Is</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#readpackagejson" class="tsd-kind-icon">read<wbr>Package<wbr>Json</a>
|
||||
</li>
|
||||
@@ -1188,6 +1369,12 @@ sha256(<span class="hljs-string">'test'</span>)
|
||||
<li class=" tsd-kind-object-literal">
|
||||
<a href="globals.html#livetasks" class="tsd-kind-icon">Live<wbr>Tasks</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#env" class="tsd-kind-icon">env</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#sandboxoptions" class="tsd-kind-icon">sandbox<wbr>Options</a>
|
||||
</li>
|
||||
|
||||
46
index.html
46
index.html
@@ -158,6 +158,7 @@ git cz
|
||||
<pre><code class="lang-bash"><span class="hljs-comment"># bump package.json version, update CHANGELOG.md, git tag the release</span>
|
||||
npm run changelog
|
||||
</code></pre>
|
||||
<p>You may find a tool like <a href="https://github.com/bitjson/wip"><strong><code>wip</code></strong></a> helpful for managing work in progress before you're ready to create a meaningful commit.</p>
|
||||
<h2 id="one-step-publish-preparation-script">One-step publish preparation script</h2>
|
||||
<p>Bringing together many of the steps above, this repo includes a one-step release preparation command.</p>
|
||||
<pre><code class="lang-bash"><span class="hljs-comment"># Prepare a standard release:</span>
|
||||
@@ -281,9 +282,10 @@ npm link
|
||||
<pre><code><span class="hljs-built_in">mkdir</span> typescript-starter-testing
|
||||
<span class="hljs-built_in">cd</span> typescript-starter-testing
|
||||
TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/typescript-starter' typescript-starter
|
||||
</code></pre><p>You can also <code>TYPESCRIPT_STARTER_REPO_URL</code> to any valid Git URL, such as your fork of this repo:</p>
|
||||
</code></pre><p>You can also set <code>TYPESCRIPT_STARTER_REPO_URL</code> to any valid Git URL, such as your fork of this repo:</p>
|
||||
<pre><code><span class="hljs-attr">TYPESCRIPT_STARTER_REPO_URL</span>=<span class="hljs-string">'https://github.com/YOUR_USERNAME/typescript-starter.git'</span> typescript-starter
|
||||
</code></pre><p>If you're using <a href="https://code.visualstudio.com/">VS Code</a>, the <code>Debug CLI</code> launch configuration also allows you to immediately build and step through execution of the CLI.</p>
|
||||
</code></pre><p>If <code>TYPESCRIPT_STARTER_REPO_BRANCH</code> is not provided, it will default to <code>master</code>.</p>
|
||||
<p>If you're using <a href="https://code.visualstudio.com/">VS Code</a>, the <code>Debug CLI</code> launch configuration also allows you to immediately build and step through execution of the CLI.</p>
|
||||
<h1 id="in-the-wild">In the wild</h1>
|
||||
<p>You can find more advanced configurations, usage examples, and inspiration from other projects using <code>typescript-starter</code>:</p>
|
||||
<ul>
|
||||
@@ -315,6 +317,9 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/tasks.html" class="tsd-kind-icon">Tasks</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarterclioptions.html" class="tsd-kind-icon">Typescript<wbr>StarterCLIOptions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarterinferredoptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
@@ -322,7 +327,16 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<a href="interfaces/typescriptstarteroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/typescriptstarteruseroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a>
|
||||
<a href="interfaces/typescriptstarterrequiredconfig.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Required<wbr>Config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#typescriptstarterargsoptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Args<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#typescriptstarteruseroptions" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#branch" class="tsd-kind-icon">branch</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#builddir" class="tsd-kind-icon">build<wbr>Dir</a>
|
||||
@@ -336,12 +350,12 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#inherit" class="tsd-kind-icon">inherit</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#repourl" class="tsd-kind-icon">repoURL</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#up" class="tsd-kind-icon">up</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#addinferredoptions" class="tsd-kind-icon">add<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#asyncabc" class="tsd-kind-icon">asyncABC</a>
|
||||
</li>
|
||||
@@ -357,18 +371,18 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getgithubusername" class="tsd-kind-icon">get<wbr>Github<wbr>Username</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getinferredoptions" class="tsd-kind-icon">get<wbr>Inferred<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getintro" class="tsd-kind-icon">get<wbr>Intro</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getrepourl" class="tsd-kind-icon">get<wbr>Repo<wbr>Url</a>
|
||||
<a href="globals.html#getrepoinfo" class="tsd-kind-icon">get<wbr>Repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#getuserinfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#hasclioptions" class="tsd-kind-icon">hasCLIOptions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#hash" class="tsd-kind-icon">hash</a>
|
||||
</li>
|
||||
@@ -390,12 +404,12 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#ms" class="tsd-kind-icon">ms</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#passupdatenotifier" class="tsd-kind-icon">pass<wbr>Update<wbr>Notifier</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#power" class="tsd-kind-icon">power</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#pretendlatestversionis" class="tsd-kind-icon">pretend<wbr>Latest<wbr>Version<wbr>Is</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||||
<a href="globals.html#readpackagejson" class="tsd-kind-icon">read<wbr>Package<wbr>Json</a>
|
||||
</li>
|
||||
@@ -426,6 +440,12 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>/to/t
|
||||
<li class=" tsd-kind-object-literal">
|
||||
<a href="globals.html#livetasks" class="tsd-kind-icon">Live<wbr>Tasks</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#env" class="tsd-kind-icon">env</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal tsd-is-not-exported">
|
||||
<a href="globals.html#sandboxoptions" class="tsd-kind-icon">sandbox<wbr>Options</a>
|
||||
</li>
|
||||
|
||||
@@ -97,7 +97,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">clone<wbr>Repo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L132">cli/tasks.ts:132</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L162">cli/tasks.ts:162</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -105,14 +105,22 @@
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>repoURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, workingDirectory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dir<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>repoInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, workingDirectory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dir<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>repoURL: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>repoInfo: <span class="tsd-signature-type">object</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>workingDirectory: <span class="tsd-signature-type">string</span></h5>
|
||||
@@ -134,7 +142,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">initial<wbr>Commit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L137">cli/tasks.ts:137</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L170">cli/tasks.ts:170</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -171,7 +179,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/tasks.ts#L142">cli/tasks.ts:142</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/tasks.ts#L175">cli/tasks.ts:175</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TypescriptStarterUserOptions | typescript-starter</title>
|
||||
<title>TypescriptStarterCLIOptions | typescript-starter</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
@@ -56,10 +56,10 @@
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>
|
||||
<a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface TypescriptStarterUserOptions</h1>
|
||||
<h1>Interface TypescriptStarterCLIOptions</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
@@ -70,7 +70,7 @@
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">TypescriptStarterUserOptions</span>
|
||||
<span class="target">TypescriptStarterCLIOptions</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="typescriptstarteroptions.html" class="tsd-signature-type">TypescriptStarterOptions</a>
|
||||
@@ -86,15 +86,15 @@
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#description" class="tsd-kind-icon">description</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#domdefinitions" class="tsd-kind-icon">dom<wbr>Definitions</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#immutable" class="tsd-kind-icon">immutable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#install" class="tsd-kind-icon">install</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#nodedefinitions" class="tsd-kind-icon">node<wbr>Definitions</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#runner" class="tsd-kind-icon">runner</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#strict" class="tsd-kind-icon">strict</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarteruseroptions.html#vscode" class="tsd-kind-icon">vscode</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#description" class="tsd-kind-icon">description</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#domdefinitions" class="tsd-kind-icon">dom<wbr>Definitions</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#immutable" class="tsd-kind-icon">immutable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#install" class="tsd-kind-icon">install</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#nodedefinitions" class="tsd-kind-icon">node<wbr>Definitions</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#runner" class="tsd-kind-icon">runner</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#strict" class="tsd-kind-icon">strict</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterclioptions.html#vscode" class="tsd-kind-icon">vscode</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">description<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L11">cli/utils.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L11">cli/utils.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -118,7 +118,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">dom<wbr>Definitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -128,7 +128,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">immutable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L13">cli/utils.ts:13</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L13">cli/utils.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -138,7 +138,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L14">cli/utils.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L14">cli/utils.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -148,7 +148,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">node<wbr>Definitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L15">cli/utils.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L15">cli/utils.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -158,7 +158,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">project<wbr>Name<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L16">cli/utils.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L16">cli/utils.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -168,7 +168,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">runner<span class="tsd-signature-symbol">:</span> <a href="../enums/runner.html" class="tsd-signature-type">Runner</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L17">cli/utils.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L17">cli/utils.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -178,7 +178,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L18">cli/utils.ts:18</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L18">cli/utils.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -188,7 +188,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">vscode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L19">cli/utils.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L19">cli/utils.ts:19</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -207,34 +207,34 @@
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options</a>
|
||||
<a href="typescriptstarterclioptions.html" class="tsd-kind-icon">Typescript<wbr>StarterCLIOptions</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#description" class="tsd-kind-icon">description</a>
|
||||
<a href="typescriptstarterclioptions.html#description" class="tsd-kind-icon">description</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#domdefinitions" class="tsd-kind-icon">dom<wbr>Definitions</a>
|
||||
<a href="typescriptstarterclioptions.html#domdefinitions" class="tsd-kind-icon">dom<wbr>Definitions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#immutable" class="tsd-kind-icon">immutable</a>
|
||||
<a href="typescriptstarterclioptions.html#immutable" class="tsd-kind-icon">immutable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#install" class="tsd-kind-icon">install</a>
|
||||
<a href="typescriptstarterclioptions.html#install" class="tsd-kind-icon">install</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#nodedefinitions" class="tsd-kind-icon">node<wbr>Definitions</a>
|
||||
<a href="typescriptstarterclioptions.html#nodedefinitions" class="tsd-kind-icon">node<wbr>Definitions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a>
|
||||
<a href="typescriptstarterclioptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#runner" class="tsd-kind-icon">runner</a>
|
||||
<a href="typescriptstarterclioptions.html#runner" class="tsd-kind-icon">runner</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#strict" class="tsd-kind-icon">strict</a>
|
||||
<a href="typescriptstarterclioptions.html#strict" class="tsd-kind-icon">strict</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarteruseroptions.html#vscode" class="tsd-kind-icon">vscode</a>
|
||||
<a href="typescriptstarterclioptions.html#vscode" class="tsd-kind-icon">vscode</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -89,7 +89,7 @@
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#email" class="tsd-kind-icon">email</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#fullname" class="tsd-kind-icon">full<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#githubusername" class="tsd-kind-icon">github<wbr>Username</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#repourl" class="tsd-kind-icon">repoURL</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterinferredoptions.html#workingdirectory" class="tsd-kind-icon">working<wbr>Directory</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -104,7 +104,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">email<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L25">cli/utils.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L37">cli/utils.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -114,7 +114,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">full<wbr>Name<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L24">cli/utils.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L36">cli/utils.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -124,19 +124,30 @@
|
||||
<div class="tsd-signature tsd-kind-icon">github<wbr>Username<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L23">cli/utils.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L35">cli/utils.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="repourl" class="tsd-anchor"></a>
|
||||
<h3>repoURL</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repoURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<a name="repoinfo" class="tsd-anchor"></a>
|
||||
<h3>repo<wbr>Info</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repo<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L26">cli/utils.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L38">cli/utils.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="workingdirectory" class="tsd-anchor"></a>
|
||||
@@ -144,7 +155,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">working<wbr>Directory<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/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L27">cli/utils.ts:27</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L42">cli/utils.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -175,7 +186,7 @@
|
||||
<a href="typescriptstarterinferredoptions.html#githubusername" class="tsd-kind-icon">github<wbr>Username</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarterinferredoptions.html#repourl" class="tsd-kind-icon">repoURL</a>
|
||||
<a href="typescriptstarterinferredoptions.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarterinferredoptions.html#workingdirectory" class="tsd-kind-icon">working<wbr>Directory</a>
|
||||
|
||||
@@ -70,7 +70,7 @@
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="typescriptstarteruseroptions.html" class="tsd-signature-type">TypescriptStarterUserOptions</a>
|
||||
<a href="typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="typescriptstarterinferredoptions.html" class="tsd-signature-type">TypescriptStarterInferredOptions</a>
|
||||
@@ -98,7 +98,7 @@
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#install" class="tsd-kind-icon">install</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#nodedefinitions" class="tsd-kind-icon">node<wbr>Definitions</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#repourl" class="tsd-kind-icon">repoURL</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#runner" class="tsd-kind-icon">runner</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#strict" class="tsd-kind-icon">strict</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="typescriptstarteroptions.html#vscode" class="tsd-kind-icon">vscode</a></li>
|
||||
@@ -115,9 +115,9 @@
|
||||
<h3>description</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#description">description</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#description">description</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L11">cli/utils.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L11">cli/utils.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -126,9 +126,9 @@
|
||||
<h3>dom<wbr>Definitions</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">dom<wbr>Definitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#domdefinitions">domDefinitions</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#domdefinitions">domDefinitions</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -139,7 +139,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#email">email</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L25">cli/utils.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L37">cli/utils.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -150,7 +150,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#fullname">fullName</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L24">cli/utils.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L36">cli/utils.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -161,7 +161,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#githubusername">githubUsername</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L23">cli/utils.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L35">cli/utils.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -170,9 +170,9 @@
|
||||
<h3>immutable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">immutable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#immutable">immutable</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#immutable">immutable</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L13">cli/utils.ts:13</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L13">cli/utils.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -181,9 +181,9 @@
|
||||
<h3>install</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#install">install</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#install">install</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L14">cli/utils.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L14">cli/utils.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -192,9 +192,9 @@
|
||||
<h3>node<wbr>Definitions</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">node<wbr>Definitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#nodedefinitions">nodeDefinitions</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#nodedefinitions">nodeDefinitions</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L15">cli/utils.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L15">cli/utils.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -203,31 +203,42 @@
|
||||
<h3>project<wbr>Name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">project<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#projectname">projectName</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#projectname">projectName</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L16">cli/utils.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L16">cli/utils.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="repourl" class="tsd-anchor"></a>
|
||||
<h3>repoURL</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repoURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<a name="repoinfo" class="tsd-anchor"></a>
|
||||
<h3>repo<wbr>Info</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">repo<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#repourl">repoURL</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#repoinfo">repoInfo</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L26">cli/utils.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L38">cli/utils.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="runner" class="tsd-anchor"></a>
|
||||
<h3>runner</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">runner<span class="tsd-signature-symbol">:</span> <a href="../enums/runner.html" class="tsd-signature-type">Runner</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#runner">runner</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#runner">runner</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L17">cli/utils.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L17">cli/utils.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -236,9 +247,9 @@
|
||||
<h3>strict</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#strict">strict</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#strict">strict</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L18">cli/utils.ts:18</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L18">cli/utils.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -247,9 +258,9 @@
|
||||
<h3>vscode</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">vscode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarteruseroptions.html">TypescriptStarterUserOptions</a>.<a href="typescriptstarteruseroptions.html#vscode">vscode</a></p>
|
||||
<p>Inherited from <a href="typescriptstarterclioptions.html">TypescriptStarterCLIOptions</a>.<a href="typescriptstarterclioptions.html#vscode">vscode</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L19">cli/utils.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L19">cli/utils.ts:19</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -260,7 +271,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="typescriptstarterinferredoptions.html">TypescriptStarterInferredOptions</a>.<a href="typescriptstarterinferredoptions.html#workingdirectory">workingDirectory</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/83fdc67/src/cli/utils.ts#L27">cli/utils.ts:27</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L42">cli/utils.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -309,7 +320,7 @@
|
||||
<a href="typescriptstarteroptions.html#projectname" class="tsd-kind-icon">project<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="typescriptstarteroptions.html#repourl" class="tsd-kind-icon">repoURL</a>
|
||||
<a href="typescriptstarteroptions.html#repoinfo" class="tsd-kind-icon">repo<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="typescriptstarteroptions.html#runner" class="tsd-kind-icon">runner</a>
|
||||
|
||||
211
interfaces/typescriptstarterrequiredconfig.html
Normal file
211
interfaces/typescriptstarterrequiredconfig.html
Normal file
@@ -0,0 +1,211 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TypescriptStarterRequiredConfig | typescript-starter</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</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">typescript-starter</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="typescriptstarterrequiredconfig.html">TypescriptStarterRequiredConfig</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface TypescriptStarterRequiredConfig</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">TypescriptStarterRequiredConfig</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterrequiredconfig.html#install" class="tsd-kind-icon">install</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="typescriptstarterrequiredconfig.html#starterversion" class="tsd-kind-icon">starter<wbr>Version</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="install" class="tsd-anchor"></a>
|
||||
<h3>install</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L24">cli/utils.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="starterversion" class="tsd-anchor"></a>
|
||||
<h3>starter<wbr>Version</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">starter<wbr>Version<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/bitjson/typescript-starter/blob/3f8123e/src/cli/utils.ts#L23">cli/utils.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="typescriptstarterrequiredconfig.html" class="tsd-kind-icon">Typescript<wbr>Starter<wbr>Required<wbr>Config</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarterrequiredconfig.html#install" class="tsd-kind-icon">install</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="typescriptstarterrequiredconfig.html#starterversion" class="tsd-kind-icon">starter<wbr>Version</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user