Starter/typescript-starter
1
0
Fork 0
mirror of synced 2025-11-08 21:07:23 +00:00
Code Issues Releases Wiki Activity

[ci skip] Updates

Browse Source
This commit is contained in:
Jason Dreyzehner
2018-08-21 01:53:50 -04:00
parent 07cd476d1f
commit 531502ec88
10 changed files with 141 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
globals.html
View File

@@ -156,7 +156,7 @@
<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/7796910/src/cli/utils.ts#L33">cli/utils.ts:33</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/utils.ts#L33">cli/utils.ts:33</a></li>
</ul>
</aside>
</section>
@@ -166,7 +166,7 @@
<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"> &amp; </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/7796910/src/cli/utils.ts#L30">cli/utils.ts:30</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/utils.ts#L30">cli/utils.ts:30</a></li>
</ul>
</aside>
</section>
@@ -179,7 +179,7 @@
<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"> =&nbsp;execa.sync(&#x27;git&#x27;, [&#x27;rev-parse&#x27;,&#x27;--symbolic-full-name&#x27;,&#x27;--abbrev-ref&#x27;,&#x27;HEAD&#x27;]).stdout</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/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/8a692bf/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">
@@ -197,7 +197,7 @@
<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"> =&nbsp;join(process.cwd(), &#x27;build&#x27;)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L47">cli/tests/cli.integration.spec.ts:47</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L47">cli/tests/cli.integration.spec.ts:47</a></li>
</ul>
</aside>
</section>
@@ -207,7 +207,7 @@
<div class="tsd-signature tsd-kind-icon">down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L235">cli/tests/cli.integration.spec.ts:235</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L235">cli/tests/cli.integration.spec.ts:235</a></li>
</ul>
</aside>
</section>
@@ -219,7 +219,7 @@
&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L237">cli/tests/cli.integration.spec.ts:237</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L237">cli/tests/cli.integration.spec.ts:237</a></li>
</ul>
</aside>
</section>
@@ -229,7 +229,7 @@
<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">"inherit"</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"> =&nbsp;&#x27;inherit&#x27; as StdIOOption</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tasks.ts#L13">cli/tasks.ts:13</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L13">cli/tasks.ts:13</a></li>
</ul>
</aside>
</section>
@@ -239,7 +239,7 @@
<div class="tsd-signature tsd-kind-icon">up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L236">cli/tests/cli.integration.spec.ts:236</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L236">cli/tests/cli.integration.spec.ts:236</a></li>
</ul>
</aside>
</section>
@@ -256,7 +256,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tasks.ts#L189">cli/tasks.ts:189</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L189">cli/tasks.ts:189</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -279,7 +279,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/lib/async.ts#L20">lib/async.ts:20</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/lib/async.ts#L20">lib/async.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -287,15 +287,13 @@
<p>A sample async function (to demo Typescript&#39;s es7 async/await downleveling).</p>
</div>
<h3 id="example-es-imports-">Example (es imports)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">import</span> { asyncABC } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
<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">// =&gt; ['a','b','c']</span>
</code></pre>
<span class="hljs-comment">// =&gt; ['a','b','c']</span></code></pre>
<h3 id="example-commonjs-">Example (commonjs)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> double = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).asyncABC;
<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">// =&gt; ['a','b','c']</span>
</code></pre>
<span class="hljs-comment">// =&gt; ['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">&lt;</span><span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a Promise which should contain <code>[&#39;a&#39;,&#39;b&#39;,&#39;c&#39;]</code></p>
@@ -312,7 +310,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/7796910/src/cli/args.ts#L7">cli/args.ts:7</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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">&lt;</span><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -329,7 +327,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/7796910/src/cli/tasks.ts#L23">cli/tasks.ts:23</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L23">cli/tasks.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -355,7 +353,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/7796910/src/lib/number.ts#L22">lib/number.ts:22</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/lib/number.ts#L22">lib/number.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -363,15 +361,13 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
<p>Multiplies a value by 2. (Also a full example of Typedoc&#39;s functionality.)</p>
</div>
<h3 id="example-es-module-">Example (es module)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">import</span> { double } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
<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">// =&gt; 8</span>
</code></pre>
<span class="hljs-comment">// =&gt; 8</span></code></pre>
<h3 id="example-commonjs-">Example (commonjs)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> double = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).double;
<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">// =&gt; 8</span>
</code></pre>
<span class="hljs-comment">// =&gt; 8</span></code></pre>
<dl class="tsd-comment-tags">
<dt>anothernote</dt>
<dd><p>Some other value.</p>
@@ -402,7 +398,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/7796910/src/cli/tasks.ts#L75">cli/tasks.ts:75</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L75">cli/tasks.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -425,7 +421,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/7796910/src/cli/utils.ts#L68">cli/utils.ts:68</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/utils.ts#L68">cli/utils.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -448,7 +444,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/7796910/src/cli/tasks.ts#L153">cli/tasks.ts:153</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L153">cli/tasks.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -492,7 +488,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/7796910/src/cli/tasks.ts#L86">cli/tasks.ts:86</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L86">cli/tasks.ts:86</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -515,7 +511,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/7796910/src/cli/utils.ts#L54">cli/utils.ts:54</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/utils.ts#L54">cli/utils.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -538,7 +534,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/7796910/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/8a692bf/src/lib/hash.spec.ts#L5">lib/hash.spec.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -567,7 +563,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/7796910/src/cli/tests/cli.integration.spec.ts#L101">cli/tests/cli.integration.spec.ts:101</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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>
@@ -593,7 +589,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/7796910/src/cli/tasks.ts#L106">cli/tasks.ts:106</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L106">cli/tasks.ts:106</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -616,7 +612,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/7796910/src/cli/inquire.ts#L4">cli/inquire.ts:4</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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">&lt;</span><a href="interfaces/typescriptstarterclioptions.html" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -633,7 +629,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/7796910/src/cli/tasks.ts#L128">cli/tasks.ts:128</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L128">cli/tasks.ts:128</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -656,7 +652,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/7796910/src/cli/tests/cli.unit.spec.ts#L131">cli/tests/cli.unit.spec.ts:131</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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>
@@ -679,7 +675,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/7796910/src/cli/tests/cli.integration.spec.ts#L238">cli/tests/cli.integration.spec.ts:238</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L238">cli/tests/cli.integration.spec.ts:238</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -702,7 +698,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/7796910/src/lib/number.ts#L43">lib/number.ts:43</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/lib/number.ts#L43">lib/number.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -710,15 +706,13 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
<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="lang-js"><span class="hljs-keyword">import</span> { power } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
<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">// =&gt; 8</span>
</code></pre>
<span class="hljs-comment">// =&gt; 8</span></code></pre>
<h3 id="example-commonjs-">Example (commonjs)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> power = <span class="hljs-built_in">require</span>(<span class="hljs-string">'typescript-starter'</span>).power;
<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">// =&gt; 8</span>
</code></pre>
<span class="hljs-comment">// =&gt; 8</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@@ -743,7 +737,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/7796910/src/cli/tests/cli.unit.spec.ts#L35">cli/tests/cli.unit.spec.ts:35</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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>
@@ -766,7 +760,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/7796910/src/cli/typescript-starter.ts#L258">cli/typescript-starter.ts:258</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/typescript-starter.ts#L258">cli/typescript-starter.ts:258</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -789,7 +783,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/7796910/src/cli/tests/cli.integration.spec.ts#L387">cli/tests/cli.integration.spec.ts:387</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L387">cli/tests/cli.integration.spec.ts:387</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -818,7 +812,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/7796910/src/lib/hash.ts#L16">lib/hash.ts:16</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/lib/hash.ts#L16">lib/hash.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -826,10 +820,9 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
<p>Calculate the sha256 digest of a string.</p>
</div>
<h3 id="example-es-imports-">Example (es imports)</h3>
<pre><code class="lang-js"><span class="hljs-keyword">import</span> { sha256 } <span class="hljs-keyword">from</span> <span class="hljs-string">'typescript-starter'</span>
<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">// =&gt; '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span>
</code></pre>
<span class="hljs-comment">// =&gt; '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@@ -852,7 +845,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/7796910/src/lib/hash.ts#L34">lib/hash.ts:34</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/lib/hash.ts#L34">lib/hash.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -860,10 +853,9 @@ sha256(<span class="hljs-string">'test'</span>)
<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="lang-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>
<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">// =&gt; '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span>
</code></pre>
<span class="hljs-comment">// =&gt; '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@@ -886,7 +878,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/7796910/src/cli/tests/cli.integration.spec.ts#L410">cli/tests/cli.integration.spec.ts:410</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L410">cli/tests/cli.integration.spec.ts:410</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -909,7 +901,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/7796910/src/cli/tests/cli.integration.spec.ts#L241">cli/tests/cli.integration.spec.ts:241</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L241">cli/tests/cli.integration.spec.ts:241</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -938,7 +930,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/7796910/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/8a692bf/src/cli/typescript-starter.ts#L11">cli/typescript-starter.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1025,7 +1017,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/7796910/src/cli/utils.ts#L60">cli/utils.ts:60</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/utils.ts#L60">cli/utils.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1051,7 +1043,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/7796910/src/cli/typescript-starter.ts#L261">cli/typescript-starter.ts:261</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/typescript-starter.ts#L261">cli/typescript-starter.ts:261</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1076,7 +1068,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/7796910/src/cli/tasks.ts#L184">cli/tasks.ts:184</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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">
@@ -1085,7 +1077,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"> =&nbsp;cloneRepo(execa)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tasks.ts#L185">cli/tasks.ts:185</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L185">cli/tasks.ts:185</a></li>
</ul>
</aside>
</section>
@@ -1095,7 +1087,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"> =&nbsp;initialCommit(execa)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tasks.ts#L186">cli/tasks.ts:186</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L186">cli/tasks.ts:186</a></li>
</ul>
</aside>
</section>
@@ -1105,7 +1097,7 @@ 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"> =&nbsp;install(execa)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tasks.ts#L187">cli/tasks.ts:187</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tasks.ts#L187">cli/tasks.ts:187</a></li>
</ul>
</aside>
</section>
@@ -1116,7 +1108,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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/7796910/src/cli/tests/cli.integration.spec.ts#L48">cli/tests/cli.integration.spec.ts:48</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/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">
@@ -1125,7 +1117,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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"> =&nbsp;repoInfo.branch</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L49">cli/tests/cli.integration.spec.ts:49</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L49">cli/tests/cli.integration.spec.ts:49</a></li>
</ul>
</aside>
</section>
@@ -1135,7 +1127,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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"> =&nbsp;repoInfo.repo</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L50">cli/tests/cli.integration.spec.ts:50</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L50">cli/tests/cli.integration.spec.ts:50</a></li>
</ul>
</aside>
</section>
@@ -1146,7 +1138,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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/7796910/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/8a692bf/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">
@@ -1155,7 +1147,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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"> =&nbsp;branch &#x3D;&#x3D;&#x3D; &#x27;HEAD&#x27; ? &#x27;.&#x27; : branch</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/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/8a692bf/src/cli/tests/cli.integration.spec.ts#L44">cli/tests/cli.integration.spec.ts:44</a></li>
</ul>
</aside>
</section>
@@ -1165,7 +1157,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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"> =&nbsp;process.cwd()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/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/8a692bf/src/cli/tests/cli.integration.spec.ts#L45">cli/tests/cli.integration.spec.ts:45</a></li>
</ul>
</aside>
</section>
@@ -1176,7 +1168,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/7796910/src/cli/tests/cli.integration.spec.ts#L403">cli/tests/cli.integration.spec.ts:403</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L403">cli/tests/cli.integration.spec.ts:403</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
@@ -1185,7 +1177,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"> =&nbsp;&quot;this is an example description&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L404">cli/tests/cli.integration.spec.ts:404</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L404">cli/tests/cli.integration.spec.ts:404</a></li>
</ul>
</aside>
</section>
@@ -1195,7 +1187,7 @@ 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"> =&nbsp;&quot;SOME_GITHUB_USERNAME&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L405">cli/tests/cli.integration.spec.ts:405</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L405">cli/tests/cli.integration.spec.ts:405</a></li>
</ul>
</aside>
</section>
@@ -1205,7 +1197,7 @@ sha256(<span class="hljs-string">'test'</span>)
<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/7796910/src/cli/tests/cli.integration.spec.ts#L406">cli/tests/cli.integration.spec.ts:406</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L406">cli/tests/cli.integration.spec.ts:406</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -1226,7 +1218,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"> =&nbsp;buildDir</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/7796910/src/cli/tests/cli.integration.spec.ts#L407">cli/tests/cli.integration.spec.ts:407</a></li>
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/8a692bf/src/cli/tests/cli.integration.spec.ts#L407">cli/tests/cli.integration.spec.ts:407</a></li>
</ul>
</aside>
</section>