1496 lines
91 KiB
HTML
1496 lines
91 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>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>
|
||
</ul>
|
||
<h1> typescript-starter</h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<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>Enumerations</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-enum"><a href="enums/placeholders.html" class="tsd-kind-icon">Placeholders</a></li>
|
||
<li class="tsd-kind-enum"><a href="enums/runner.html" class="tsd-kind-icon">Runner</a></li>
|
||
<li class="tsd-kind-enum tsd-is-not-exported"><a href="enums/testdirectories.html" class="tsd-kind-icon">Test<wbr>Directories</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<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/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#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#getintro" class="tsd-kind-icon">get<wbr>Intro</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 tsd-is-not-exported"><a href="globals.html#ignorepackagejson" class="tsd-kind-icon">ignore<wbr>Package<wbr>Json</a></li>
|
||
<li class="tsd-kind-function"><a href="globals.html#initialcommit" class="tsd-kind-icon">initial<wbr>Commit</a></li>
|
||
<li class="tsd-kind-function"><a href="globals.html#inquire" class="tsd-kind-icon">inquire</a></li>
|
||
<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"><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>
|
||
<li class="tsd-kind-function"><a href="globals.html#sha256native" class="tsd-kind-icon">sha256<wbr>Native</a></li>
|
||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#silenceconsole" class="tsd-kind-icon">silence<wbr>Console</a></li>
|
||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testinteractive" class="tsd-kind-icon">test<wbr>Interactive</a></li>
|
||
<li class="tsd-kind-function"><a href="globals.html#typescriptstarter" class="tsd-kind-icon">typescript<wbr>Starter</a></li>
|
||
<li class="tsd-kind-function"><a href="globals.html#validatename" class="tsd-kind-icon">validate<wbr>Name</a></li>
|
||
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#writepackagejson" class="tsd-kind-icon">write<wbr>Package<wbr>Json</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<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/4060de3/src/cli/utils.ts#L33">cli/utils.ts:33</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/4060de3/src/cli/utils.ts#L30">cli/utils.ts:30</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="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/4060de3/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">
|
||
<div class="lead">
|
||
<p>NOTE: many of the tests below validate file modification. The filesystem is
|
||
not mocked, and these tests make real changes. Proceed with caution.</p>
|
||
</div>
|
||
<p>Filesystem changes made by these tests should be contained in the <code>build</code>
|
||
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/4060de3/src/cli/tests/cli.integration.spec.ts#L47">cli/tests/cli.integration.spec.ts:47</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/4060de3/src/cli/tests/cli.integration.spec.ts#L250">cli/tests/cli.integration.spec.ts:250</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/4060de3/src/cli/tests/cli.integration.spec.ts#L252">cli/tests/cli.integration.spec.ts:252</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">"inherit"</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/4060de3/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/4060de3/src/cli/tests/cli.integration.spec.ts#L251">cli/tests/cli.integration.spec.ts:251</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/4060de3/src/cli/tasks.ts#L189">cli/tasks.ts:189</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>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">asyncABC<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">ReadonlyArray</span><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></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/4060de3/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>A sample async function (to demo Typescript's es7 async/await downleveling).</p>
|
||
</div>
|
||
<h3 id="example-es-imports-">Example (es imports)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">import</span> { asyncABC } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
|
||
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">await</span> asyncABC())
|
||
<span class="hljs-comment">// => ['a','b','c']</span></code></pre>
|
||
<h3 id="example-commonjs-">Example (commonjs)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">var</span> double = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).asyncABC;
|
||
asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||
<span class="hljs-comment">// => ['a','b','c']</span></code></pre>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ReadonlyArray</span><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></h4>
|
||
<p>a Promise which should contain <code>['a','b','c']</code></p>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<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><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/4060de3/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><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="clonerepo" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> clone<wbr>Repo</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">clone<wbr>Repo<span class="tsd-signature-symbol">(</span>spawner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaStatic</span>, suppressOutput<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/4060de3/src/cli/tasks.ts#L23">cli/tasks.ts:23</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>spawner: <span class="tsd-signature-type">ExecaStatic</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> suppressOutput: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="double" class="tsd-anchor"></a>
|
||
<h3>double</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">double<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/4060de3/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Multiplies a value by 2. (Also a full example of Typedoc's functionality.)</p>
|
||
</div>
|
||
<h3 id="example-es-module-">Example (es module)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">import</span> { double } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
|
||
<span class="hljs-built_in">console</span>.log(double(<span class="hljs-number">4</span>))
|
||
<span class="hljs-comment">// => 8</span></code></pre>
|
||
<h3 id="example-commonjs-">Example (commonjs)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">var</span> double = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).double;
|
||
<span class="hljs-built_in">console</span>.log(double(<span class="hljs-number">4</span>))
|
||
<span class="hljs-comment">// => 8</span></code></pre>
|
||
<dl class="tsd-comment-tags">
|
||
<dt>anothernote</dt>
|
||
<dd><p>Some other value.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>value: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
<p>Comment describing the <code>value</code> parameter.</p>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
<p>Comment describing the return type.</p>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="getgithubusername" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Github<wbr>Username</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">get<wbr>Github<wbr>Username<span class="tsd-signature-symbol">(</span>fetcher<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/4060de3/src/cli/tasks.ts#L75">cli/tasks.ts:75</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>fetcher: <span class="tsd-signature-type">any</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</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>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">get<wbr>Intro<span class="tsd-signature-symbol">(</span>columns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/4060de3/src/cli/utils.ts#L68">cli/utils.ts:68</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>columns: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<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>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/4060de3/src/cli/tasks.ts#L153">cli/tasks.ts:153</a></li>
|
||
</ul>
|
||
</aside>
|
||
<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>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="getuserinfo" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>User<wbr>Info</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Info<span class="tsd-signature-symbol">(</span>spawner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaStatic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/4060de3/src/cli/tasks.ts#L86">cli/tasks.ts:86</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>spawner: <span class="tsd-signature-type">ExecaStatic</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
||
</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/4060de3/src/cli/utils.ts#L54">cli/utils.ts:54</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>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">(</span>t<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, expected<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/4060de3/src/lib/hash.spec.ts#L5">lib/hash.spec.ts:5</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>t: <span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>input: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>expected: <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="hashallthethings" class="tsd-anchor"></a>
|
||
<h3>hash<wbr>All<wbr>The<wbr>Things</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">hash<wbr>All<wbr>The<wbr>Things<span class="tsd-signature-symbol">(</span>projectName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sandboxed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4060de3/src/cli/tests/cli.integration.spec.ts#L101">cli/tests/cli.integration.spec.ts:101</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>projectName: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> sandboxed: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <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></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="ignorepackagejson" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> ignore<wbr>Package<wbr>Json</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">ignore<wbr>Package<wbr>Json<span class="tsd-signature-symbol">(</span>map<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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/4060de3/src/cli/tests/cli.integration.spec.ts#L153">cli/tests/cli.integration.spec.ts:153</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Since we're using Greenkeeper to keep dependencies fresh, including
|
||
<code>package.json</code> in these file fingerprint tests guarantees that every
|
||
Greenkeeper PR will trigger a false-positive test failure.</p>
|
||
</div>
|
||
<p>Here we trade complete assurance that <code>package.json</code> is correct for much less
|
||
noisy build results.</p>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>map: <span class="tsd-signature-type">object</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-index-signature">
|
||
<h5><span class="tsd-signature-symbol">[</span>file: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
||
<ul class="tsd-parameters">
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="initialcommit" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> initial<wbr>Commit</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">initial<wbr>Commit<span class="tsd-signature-symbol">(</span>spawner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaStatic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/4060de3/src/cli/tasks.ts#L106">cli/tasks.ts:106</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>spawner: <span class="tsd-signature-type">ExecaStatic</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<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/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/4060de3/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/typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="install" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> install</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">(</span>spawner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaStatic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/4060de3/src/cli/tasks.ts#L128">cli/tasks.ts:128</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>spawner: <span class="tsd-signature-type">ExecaStatic</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="mockerr" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> mock<wbr>Err</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">mock<wbr>Err<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaStatic</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/4060de3/src/cli/tests/cli.unit.spec.ts#L131">cli/tests/cli.unit.spec.ts:131</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> code: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaStatic</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="ms" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> ms</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">ms<span class="tsd-signature-symbol">(</span>milliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">void</span><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/4060de3/src/cli/tests/cli.integration.spec.ts#L253">cli/tests/cli.integration.spec.ts:253</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>milliseconds: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="power" class="tsd-anchor"></a>
|
||
<h3>power</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">power<span class="tsd-signature-symbol">(</span>base<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, exponent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/4060de3/src/lib/number.ts#L43">lib/number.ts:43</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Raise the value of the first parameter to the power of the second using the es7 <code>**</code> operator.</p>
|
||
</div>
|
||
<h3 id="example-es-module-">Example (es module)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">import</span> { power } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
|
||
<span class="hljs-built_in">console</span>.log(power(<span class="hljs-number">2</span>,<span class="hljs-number">3</span>))
|
||
<span class="hljs-comment">// => 8</span></code></pre>
|
||
<h3 id="example-commonjs-">Example (commonjs)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">var</span> power = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).power;
|
||
<span class="hljs-built_in">console</span>.log(power(<span class="hljs-number">2</span>,<span class="hljs-number">3</span>))
|
||
<span class="hljs-comment">// => 8</span></code></pre>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>base: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>exponent: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
</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/4060de3/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>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">read<wbr>Package<wbr>Json<span class="tsd-signature-symbol">(</span>path<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">any</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/4060de3/src/cli/typescript-starter.ts#L258">cli/typescript-starter.ts:258</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="sandboxtasks" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> sandbox<wbr>Tasks</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">sandbox<wbr>Tasks<span class="tsd-signature-symbol">(</span>t<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span>, commit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, install<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/tasks.html" class="tsd-signature-type">Tasks</a></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/4060de3/src/cli/tests/cli.integration.spec.ts#L404">cli/tests/cli.integration.spec.ts:404</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>t: <span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>commit: <span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>install: <span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <a href="interfaces/tasks.html" class="tsd-signature-type">Tasks</a></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="sha256" class="tsd-anchor"></a>
|
||
<h3>sha256</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">sha256<span class="tsd-signature-symbol">(</span>message<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">string</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/4060de3/src/lib/hash.ts#L16">lib/hash.ts:16</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Calculate the sha256 digest of a string.</p>
|
||
</div>
|
||
<h3 id="example-es-imports-">Example (es imports)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">import</span> { sha256 } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
|
||
sha256(<span class="hljs-string">'test'</span>)
|
||
<span class="hljs-comment">// => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span></code></pre>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||
<p>sha256 message digest</p>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="sha256native" class="tsd-anchor"></a>
|
||
<h3>sha256<wbr>Native</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">sha256<wbr>Native<span class="tsd-signature-symbol">(</span>message<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">string</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/4060de3/src/lib/hash.ts#L34">lib/hash.ts:34</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>A faster implementation of <a href="globals.html#sha256">sha256</a> which requires the native Node.js module. Browser consumers should use <a href="globals.html#sha256">sha256</a>, instead.</p>
|
||
</div>
|
||
<h3 id="example-es-imports-">Example (es imports)</h3>
|
||
<pre><code class="language-js"><span class="hljs-keyword">import</span> { sha256Native <span class="hljs-keyword">as</span> sha256 } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
|
||
sha256(<span class="hljs-string">'test'</span>)
|
||
<span class="hljs-comment">// => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span></code></pre>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||
<p>sha256 message digest</p>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="silenceconsole" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> silence<wbr>Console</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">silence<wbr>Console<span class="tsd-signature-symbol">(</span>console<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/4060de3/src/cli/tests/cli.integration.spec.ts#L427">cli/tests/cli.integration.spec.ts:427</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>console: <span class="tsd-signature-type">any</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="testinteractive" class="tsd-anchor"></a>
|
||
<h3>test<wbr>Interactive</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">test<wbr>Interactive<span class="tsd-signature-symbol">(</span>t<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span>, projectName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, entry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReadonlyArray</span><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-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">ExecaReturns</span><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/4060de3/src/cli/tests/cli.integration.spec.ts#L256">cli/tests/cli.integration.spec.ts:256</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>t: <span class="tsd-signature-type">ExecutionContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>projectName: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>entry: <span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReadonlyArray</span><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></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ExecaReturns</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="typescriptstarter" class="tsd-anchor"></a>
|
||
<h3>typescript<wbr>Starter</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">typescript<wbr>Starter<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, tasks<span class="tsd-signature-symbol">: </span><a href="interfaces/tasks.html" class="tsd-signature-type">Tasks</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><span class="tsd-signature-type">void</span><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/4060de3/src/cli/typescript-starter.ts#L11">cli/typescript-starter.ts:11</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>__namedParameters: <span class="tsd-signature-type">object</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5>appveyor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>circleci<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>dom<wbr>Definitions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>full<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>github<wbr>Username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>immutable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>install<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>node<wbr>Definitions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>project<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<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>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>strict<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>travis<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>vscode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
</li>
|
||
<li class="tsd-parameter">
|
||
<h5>working<wbr>Directory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h5>tasks: <a href="interfaces/tasks.html" class="tsd-signature-type">Tasks</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||
<a name="validatename" class="tsd-anchor"></a>
|
||
<h3>validate<wbr>Name</h3>
|
||
<ul class="tsd-signatures tsd-kind-function">
|
||
<li class="tsd-signature tsd-kind-icon">validate<wbr>Name<span class="tsd-signature-symbol">(</span>input<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">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/4060de3/src/cli/utils.ts#L60">cli/utils.ts:60</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>input: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">true</span>
|
||
<span class="tsd-signature-symbol"> | </span>
|
||
<span class="tsd-signature-type">string</span>
|
||
</h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
||
<a name="writepackagejson" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> write<wbr>Package<wbr>Json</h3>
|
||
<ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
||
<li class="tsd-signature tsd-kind-icon">write<wbr>Package<wbr>Json<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/4060de3/src/cli/typescript-starter.ts#L261">cli/typescript-starter.ts:261</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>pkg: <span class="tsd-signature-type">any</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Object literals</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
||
<a name="livetasks" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> Live<wbr>Tasks</h3>
|
||
<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/4060de3/src/cli/tasks.ts#L184">cli/tasks.ts:184</a></li>
|
||
</ul>
|
||
</aside>
|
||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||
<a name="livetasks.clonerepo" class="tsd-anchor"></a>
|
||
<h3>clone<wbr>Repo</h3>
|
||
<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/4060de3/src/cli/tasks.ts#L185">cli/tasks.ts:185</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||
<a name="livetasks.initialcommit" class="tsd-anchor"></a>
|
||
<h3>initial<wbr>Commit</h3>
|
||
<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/4060de3/src/cli/tasks.ts#L186">cli/tasks.ts:186</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||
<a name="livetasks.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">(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/4060de3/src/cli/tasks.ts#L187">cli/tasks.ts:187</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/4060de3/src/cli/tests/cli.integration.spec.ts#L48">cli/tests/cli.integration.spec.ts:48</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/4060de3/src/cli/tests/cli.integration.spec.ts#L49">cli/tests/cli.integration.spec.ts:49</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/4060de3/src/cli/tests/cli.integration.spec.ts#L50">cli/tests/cli.integration.spec.ts:50</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/4060de3/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><span class="tsd-signature-symbol"> = branch === 'HEAD' ? '.' : branch</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4060de3/src/cli/tests/cli.integration.spec.ts#L44">cli/tests/cli.integration.spec.ts:44</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/4060de3/src/cli/tests/cli.integration.spec.ts#L45">cli/tests/cli.integration.spec.ts:45</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
||
<a name="sandboxoptions" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagConst">Const</span> sandbox<wbr>Options</h3>
|
||
<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/4060de3/src/cli/tests/cli.integration.spec.ts#L420">cli/tests/cli.integration.spec.ts:420</a></li>
|
||
</ul>
|
||
</aside>
|
||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
||
<a name="sandboxoptions.description" class="tsd-anchor"></a>
|
||
<h3>description</h3>
|
||
<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/4060de3/src/cli/tests/cli.integration.spec.ts#L421">cli/tests/cli.integration.spec.ts:421</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.githubusername" class="tsd-anchor"></a>
|
||
<h3>github<wbr>Username</h3>
|
||
<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/4060de3/src/cli/tests/cli.integration.spec.ts#L422">cli/tests/cli.integration.spec.ts:422</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.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/4060de3/src/cli/tests/cli.integration.spec.ts#L423">cli/tests/cli.integration.spec.ts:423</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>
|
||
<h3>working<wbr>Directory</h3>
|
||
<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/4060de3/src/cli/tests/cli.integration.spec.ts#L424">cli/tests/cli.integration.spec.ts:424</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<nav class="tsd-navigation primary">
|
||
<ul>
|
||
<li class="globals current ">
|
||
<a href="globals.html"><em>Globals</em></a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul class="before-current">
|
||
<li class=" tsd-kind-enum">
|
||
<a href="enums/placeholders.html" class="tsd-kind-icon">Placeholders</a>
|
||
</li>
|
||
<li class=" tsd-kind-enum">
|
||
<a href="enums/runner.html" class="tsd-kind-icon">Runner</a>
|
||
</li>
|
||
<li class=" tsd-kind-enum tsd-is-not-exported">
|
||
<a href="enums/testdirectories.html" class="tsd-kind-icon">Test<wbr>Directories</a>
|
||
</li>
|
||
<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/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>
|
||
</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#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>
|
||
<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#getintro" class="tsd-kind-icon">get<wbr>Intro</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 tsd-is-not-exported">
|
||
<a href="globals.html#ignorepackagejson" class="tsd-kind-icon">ignore<wbr>Package<wbr>Json</a>
|
||
</li>
|
||
<li class=" tsd-kind-function">
|
||
<a href="globals.html#initialcommit" class="tsd-kind-icon">initial<wbr>Commit</a>
|
||
</li>
|
||
<li class=" tsd-kind-function">
|
||
<a href="globals.html#inquire" class="tsd-kind-icon">inquire</a>
|
||
</li>
|
||
<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">
|
||
<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>
|
||
<li class=" tsd-kind-function">
|
||
<a href="globals.html#sha256native" class="tsd-kind-icon">sha256<wbr>Native</a>
|
||
</li>
|
||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
<a href="globals.html#silenceconsole" class="tsd-kind-icon">silence<wbr>Console</a>
|
||
</li>
|
||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
<a href="globals.html#testinteractive" class="tsd-kind-icon">test<wbr>Interactive</a>
|
||
</li>
|
||
<li class=" tsd-kind-function">
|
||
<a href="globals.html#typescriptstarter" class="tsd-kind-icon">typescript<wbr>Starter</a>
|
||
</li>
|
||
<li class=" tsd-kind-function">
|
||
<a href="globals.html#validatename" class="tsd-kind-icon">validate<wbr>Name</a>
|
||
</li>
|
||
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
<a href="globals.html#writepackagejson" class="tsd-kind-icon">write<wbr>Package<wbr>Json</a>
|
||
</li>
|
||
<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>
|
||
</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> |