2690 lines
196 KiB
HTML
2690 lines
196 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>
|
|
</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 ">
|
|
<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"><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"><a href="globals.html#normalizepath" class="tsd-kind-icon">normalize<wbr>Path</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#readpackagejson" class="tsd-kind-icon">read<wbr>Package<wbr>Json</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"><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>
|
|
</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/710bf3e/src/cli/utils.ts#L35">cli/utils.ts:35</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/710bf3e/src/cli/utils.ts#L32">cli/utils.ts:32</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/710bf3e/src/cli/tasks.ts#L188">cli/tasks.ts:188</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/710bf3e/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>
|
|
<a href="#example-es-imports" id="example-es-imports" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (es imports)</h3>
|
|
</a>
|
|
<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>
|
|
<a href="#example-commonjs" id="example-commonjs" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (commonjs)</h3>
|
|
</a>
|
|
<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/710bf3e/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">object</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/710bf3e/src/cli/tasks.ts#L20">cli/tasks.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>spawner: <span class="tsd-signature-type">object</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file.</p>
|
|
</div>
|
|
<p>Think of this as a mix of <code>child_process.execFile</code> and <code>child_process.spawn</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa(<span class="hljs-params">'echo', ['unicorns']</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
|
|
<span class="hljs-comment">// Cancelling a spawned process</span>
|
|
<span class="hljs-keyword">const</span> subprocess = execa(<span class="hljs-params">'node'</span>);
|
|
setTimeout(<span class="hljs-params">(<span class="hljs-params"></span>) => { spawned.cancel(<span class="hljs-params"></span>) }, 1000</span>);
|
|
<span class="hljs-keyword">try</span> {
|
|
<span class="hljs-keyword">await</span> subprocess;
|
|
} <span class="hljs-keyword">catch</span> (<span class="hljs-params">error</span>) {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">subprocess.killed</span>); <span class="hljs-comment">// true</span>
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">error.isCanceled</span>); <span class="hljs-comment">// true</span>
|
|
}
|
|
}</span>)<span class="hljs-params">()</span>;
|
|
|
|
// <span class="hljs-params">Pipe</span> <span class="hljs-params">the</span> <span class="hljs-params">child</span> <span class="hljs-params">process</span> <span class="hljs-params">stdout</span> <span class="hljs-params">to</span> <span class="hljs-params">the</span> <span class="hljs-params">current</span> <span class="hljs-params">stdout</span>
|
|
<span class="hljs-params">execa</span>(<span class="hljs-params">'echo', ['unicorns']</span>).<span class="hljs-params">stdout</span>.<span class="hljs-params">pipe</span>(<span class="hljs-params">process.stdout</span>);</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:433</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa()</code> except both file and arguments are specified in a single <code>command</code> string. For example, <code>execa('echo', ['unicorns'])</code> is the same as <code>execa.command('echo unicorns')</code>.</p>
|
|
</div>
|
|
<p>If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if <code>command</code> is not a constant but a variable, for example with <code>__dirname</code> or <code>process.cwd()</code>. Except for spaces, no escaping/quoting is needed.</p>
|
|
<p>The <code>shell</code> option must be used if the <code>command</code> uses shell-specific features, as opposed to being a simple <code>file</code> followed by its <code>arguments</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa.command(<span class="hljs-params">'echo unicorns'</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
}</span>)<span class="hljs-params">()</span>;</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:434</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<wbr>Sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:442</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa.command()</code> but synchronous.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:443</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>node<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.NodeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:457</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a Node.js script as a child process.</p>
|
|
</div>
|
|
<p>Same as <code>execa('node', [scriptPath, ...arguments], options)</code> except (like <a href="https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options"><code>child_process#fork()</code></a>):</p>
|
|
<ul>
|
|
<li>the current Node version and options are used. This can be overridden using the <code>nodePath</code> and <code>nodeArguments</code> options.</li>
|
|
<li>the <code>shell</code> option cannot be used</li>
|
|
<li>an extra channel <a href="https://nodejs.org/api/child_process.html#child_process_options_stdio"><code>ipc</code></a> is passed to <a href="#stdio"><code>stdio</code></a></li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Node.js script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>scriptPath</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.NodeOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:462</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:467</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:468</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:396</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file synchronously.</p>
|
|
</div>
|
|
<p>This method throws an <code>Error</code> if the command fails.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:401</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:406</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:407</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
</ul>
|
|
</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/710bf3e/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>
|
|
<a href="#example-es-module" id="example-es-module" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (es module)</h3>
|
|
</a>
|
|
<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>
|
|
<a href="#example-commonjs" id="example-commonjs" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (commonjs)</h3>
|
|
</a>
|
|
<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/710bf3e/src/cli/tasks.ts#L73">cli/tasks.ts:73</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/710bf3e/src/cli/utils.ts#L70">cli/utils.ts:70</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/710bf3e/src/cli/tasks.ts#L152">cli/tasks.ts:152</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">object</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/710bf3e/src/cli/tasks.ts#L84">cli/tasks.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>spawner: <span class="tsd-signature-type">object</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file.</p>
|
|
</div>
|
|
<p>Think of this as a mix of <code>child_process.execFile</code> and <code>child_process.spawn</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa(<span class="hljs-params">'echo', ['unicorns']</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
|
|
<span class="hljs-comment">// Cancelling a spawned process</span>
|
|
<span class="hljs-keyword">const</span> subprocess = execa(<span class="hljs-params">'node'</span>);
|
|
setTimeout(<span class="hljs-params">(<span class="hljs-params"></span>) => { spawned.cancel(<span class="hljs-params"></span>) }, 1000</span>);
|
|
<span class="hljs-keyword">try</span> {
|
|
<span class="hljs-keyword">await</span> subprocess;
|
|
} <span class="hljs-keyword">catch</span> (<span class="hljs-params">error</span>) {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">subprocess.killed</span>); <span class="hljs-comment">// true</span>
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">error.isCanceled</span>); <span class="hljs-comment">// true</span>
|
|
}
|
|
}</span>)<span class="hljs-params">()</span>;
|
|
|
|
// <span class="hljs-params">Pipe</span> <span class="hljs-params">the</span> <span class="hljs-params">child</span> <span class="hljs-params">process</span> <span class="hljs-params">stdout</span> <span class="hljs-params">to</span> <span class="hljs-params">the</span> <span class="hljs-params">current</span> <span class="hljs-params">stdout</span>
|
|
<span class="hljs-params">execa</span>(<span class="hljs-params">'echo', ['unicorns']</span>).<span class="hljs-params">stdout</span>.<span class="hljs-params">pipe</span>(<span class="hljs-params">process.stdout</span>);</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:433</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa()</code> except both file and arguments are specified in a single <code>command</code> string. For example, <code>execa('echo', ['unicorns'])</code> is the same as <code>execa.command('echo unicorns')</code>.</p>
|
|
</div>
|
|
<p>If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if <code>command</code> is not a constant but a variable, for example with <code>__dirname</code> or <code>process.cwd()</code>. Except for spaces, no escaping/quoting is needed.</p>
|
|
<p>The <code>shell</code> option must be used if the <code>command</code> uses shell-specific features, as opposed to being a simple <code>file</code> followed by its <code>arguments</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa.command(<span class="hljs-params">'echo unicorns'</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
}</span>)<span class="hljs-params">()</span>;</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:434</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<wbr>Sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:442</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa.command()</code> but synchronous.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:443</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>node<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.NodeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:457</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a Node.js script as a child process.</p>
|
|
</div>
|
|
<p>Same as <code>execa('node', [scriptPath, ...arguments], options)</code> except (like <a href="https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options"><code>child_process#fork()</code></a>):</p>
|
|
<ul>
|
|
<li>the current Node version and options are used. This can be overridden using the <code>nodePath</code> and <code>nodeArguments</code> options.</li>
|
|
<li>the <code>shell</code> option cannot be used</li>
|
|
<li>an extra channel <a href="https://nodejs.org/api/child_process.html#child_process_options_stdio"><code>ipc</code></a> is passed to <a href="#stdio"><code>stdio</code></a></li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Node.js script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>scriptPath</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.NodeOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:462</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:467</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:468</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:396</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file synchronously.</p>
|
|
</div>
|
|
<p>This method throws an <code>Error</code> if the command fails.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:401</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:406</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:407</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
</ul>
|
|
</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/710bf3e/src/cli/utils.ts#L56">cli/utils.ts:56</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">
|
|
<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">object</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/710bf3e/src/cli/tasks.ts#L105">cli/tasks.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>spawner: <span class="tsd-signature-type">object</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file.</p>
|
|
</div>
|
|
<p>Think of this as a mix of <code>child_process.execFile</code> and <code>child_process.spawn</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa(<span class="hljs-params">'echo', ['unicorns']</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
|
|
<span class="hljs-comment">// Cancelling a spawned process</span>
|
|
<span class="hljs-keyword">const</span> subprocess = execa(<span class="hljs-params">'node'</span>);
|
|
setTimeout(<span class="hljs-params">(<span class="hljs-params"></span>) => { spawned.cancel(<span class="hljs-params"></span>) }, 1000</span>);
|
|
<span class="hljs-keyword">try</span> {
|
|
<span class="hljs-keyword">await</span> subprocess;
|
|
} <span class="hljs-keyword">catch</span> (<span class="hljs-params">error</span>) {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">subprocess.killed</span>); <span class="hljs-comment">// true</span>
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">error.isCanceled</span>); <span class="hljs-comment">// true</span>
|
|
}
|
|
}</span>)<span class="hljs-params">()</span>;
|
|
|
|
// <span class="hljs-params">Pipe</span> <span class="hljs-params">the</span> <span class="hljs-params">child</span> <span class="hljs-params">process</span> <span class="hljs-params">stdout</span> <span class="hljs-params">to</span> <span class="hljs-params">the</span> <span class="hljs-params">current</span> <span class="hljs-params">stdout</span>
|
|
<span class="hljs-params">execa</span>(<span class="hljs-params">'echo', ['unicorns']</span>).<span class="hljs-params">stdout</span>.<span class="hljs-params">pipe</span>(<span class="hljs-params">process.stdout</span>);</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:433</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa()</code> except both file and arguments are specified in a single <code>command</code> string. For example, <code>execa('echo', ['unicorns'])</code> is the same as <code>execa.command('echo unicorns')</code>.</p>
|
|
</div>
|
|
<p>If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if <code>command</code> is not a constant but a variable, for example with <code>__dirname</code> or <code>process.cwd()</code>. Except for spaces, no escaping/quoting is needed.</p>
|
|
<p>The <code>shell</code> option must be used if the <code>command</code> uses shell-specific features, as opposed to being a simple <code>file</code> followed by its <code>arguments</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa.command(<span class="hljs-params">'echo unicorns'</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
}</span>)<span class="hljs-params">()</span>;</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:434</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<wbr>Sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:442</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa.command()</code> but synchronous.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:443</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>node<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.NodeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:457</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a Node.js script as a child process.</p>
|
|
</div>
|
|
<p>Same as <code>execa('node', [scriptPath, ...arguments], options)</code> except (like <a href="https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options"><code>child_process#fork()</code></a>):</p>
|
|
<ul>
|
|
<li>the current Node version and options are used. This can be overridden using the <code>nodePath</code> and <code>nodeArguments</code> options.</li>
|
|
<li>the <code>shell</code> option cannot be used</li>
|
|
<li>an extra channel <a href="https://nodejs.org/api/child_process.html#child_process_options_stdio"><code>ipc</code></a> is passed to <a href="#stdio"><code>stdio</code></a></li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Node.js script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>scriptPath</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.NodeOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:462</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:467</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:468</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:396</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file synchronously.</p>
|
|
</div>
|
|
<p>This method throws an <code>Error</code> if the command fails.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:401</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:406</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:407</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
</ul>
|
|
</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/710bf3e/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">object</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/710bf3e/src/cli/tasks.ts#L127">cli/tasks.ts:127</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>spawner: <span class="tsd-signature-type">object</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file.</p>
|
|
</div>
|
|
<p>Think of this as a mix of <code>child_process.execFile</code> and <code>child_process.spawn</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa(<span class="hljs-params">'echo', ['unicorns']</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
|
|
<span class="hljs-comment">// Cancelling a spawned process</span>
|
|
<span class="hljs-keyword">const</span> subprocess = execa(<span class="hljs-params">'node'</span>);
|
|
setTimeout(<span class="hljs-params">(<span class="hljs-params"></span>) => { spawned.cancel(<span class="hljs-params"></span>) }, 1000</span>);
|
|
<span class="hljs-keyword">try</span> {
|
|
<span class="hljs-keyword">await</span> subprocess;
|
|
} <span class="hljs-keyword">catch</span> (<span class="hljs-params">error</span>) {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">subprocess.killed</span>); <span class="hljs-comment">// true</span>
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">error.isCanceled</span>); <span class="hljs-comment">// true</span>
|
|
}
|
|
}</span>)<span class="hljs-params">()</span>;
|
|
|
|
// <span class="hljs-params">Pipe</span> <span class="hljs-params">the</span> <span class="hljs-params">child</span> <span class="hljs-params">process</span> <span class="hljs-params">stdout</span> <span class="hljs-params">to</span> <span class="hljs-params">the</span> <span class="hljs-params">current</span> <span class="hljs-params">stdout</span>
|
|
<span class="hljs-params">execa</span>(<span class="hljs-params">'echo', ['unicorns']</span>).<span class="hljs-params">stdout</span>.<span class="hljs-params">pipe</span>(<span class="hljs-params">process.stdout</span>);</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:433</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa()</code> except both file and arguments are specified in a single <code>command</code> string. For example, <code>execa('echo', ['unicorns'])</code> is the same as <code>execa.command('echo unicorns')</code>.</p>
|
|
</div>
|
|
<p>If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if <code>command</code> is not a constant but a variable, for example with <code>__dirname</code> or <code>process.cwd()</code>. Except for spaces, no escaping/quoting is needed.</p>
|
|
<p>The <code>shell</code> option must be used if the <code>command</code> uses shell-specific features, as opposed to being a simple <code>file</code> followed by its <code>arguments</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code><span class="hljs-keyword">import</span> execa <span class="hljs-keyword">from</span> <span class="hljs-string">'execa'</span>;
|
|
|
|
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (<span class="hljs-params"></span>) => {
|
|
<span class="hljs-keyword">const</span> {stdout} = <span class="hljs-keyword">await</span> execa.command(<span class="hljs-params">'echo unicorns'</span>);
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-params">stdout</span>);
|
|
<span class="hljs-comment">//=> 'unicorns'</span>
|
|
}</span>)<span class="hljs-params">()</span>;</span></code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:434</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<wbr>Sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">command<wbr>Sync<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:442</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Same as <code>execa.command()</code> but synchronous.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute and its arguments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:443</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>node<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.NodeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">(</span>scriptPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:457</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a Node.js script as a child process.</p>
|
|
</div>
|
|
<p>Same as <code>execa('node', [scriptPath, ...arguments], options)</code> except (like <a href="https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options"><code>child_process#fork()</code></a>):</p>
|
|
<ul>
|
|
<li>the current Node version and options are used. This can be overridden using the <code>nodePath</code> and <code>nodeArguments</code> options.</li>
|
|
<li>the <code>shell</code> option cannot be used</li>
|
|
<li>an extra channel <a href="https://nodejs.org/api/child_process.html#child_process_options_stdio"><code>ipc</code></a> is passed to <a href="#stdio"><code>stdio</code></a></li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Node.js script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>scriptPath</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.NodeOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
<p>A <a href="https://nodejs.org/api/child_process.html#child_process_class_childprocess"><code>child_process</code> instance</a>, which is enhanced to also be a <code>Promise</code> for a result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:462</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:467</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:468</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scriptPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.Options</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">execa.ExecaChildProcess</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
<li class="tsd-parameter">
|
|
<h5>sync<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arguments<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">keyof string[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span></li>
|
|
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</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 /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:396</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Execute a file synchronously.</p>
|
|
</div>
|
|
<p>This method throws an <code>Error</code> if the command fails.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The program/script to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Arguments to pass to <code>file</code> on execution.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
<p>A result <code>Object</code> with <code>stdout</code> and <code>stderr</code> properties.</p>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:401</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arguments: <span class="tsd-signature-type">keyof string[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:406</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in /Users/jason/Workspace/bitjson/typescript-starter/node_modules/execa/index.d.ts:407</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">execa.SyncOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ExecaSyncReturnValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul> </li>
|
|
</ul>
|
|
</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="normalizepath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> normalize<wbr>Path</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">normalize<wbr>Path<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">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/710bf3e/src/cli/utils.ts#L99">cli/utils.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>On Windows, normalize returns "\" as the path separator.
|
|
This method normalizes with POSIX.</p>
|
|
</div>
|
|
</div>
|
|
<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">string</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/710bf3e/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>
|
|
<a href="#example-es-module" id="example-es-module" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (es module)</h3>
|
|
</a>
|
|
<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>
|
|
<a href="#example-commonjs" id="example-commonjs" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (commonjs)</h3>
|
|
</a>
|
|
<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="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/710bf3e/src/cli/typescript-starter.ts#L265">cli/typescript-starter.ts:265</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">
|
|
<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/710bf3e/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>
|
|
<a href="#example-es-imports" id="example-es-imports" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (es imports)</h3>
|
|
</a>
|
|
<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/710bf3e/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>
|
|
<a href="#example-es-imports" id="example-es-imports" style="color: inherit; text-decoration: none;">
|
|
<h3>Example (es imports)</h3>
|
|
</a>
|
|
<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">
|
|
<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/710bf3e/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>editorconfig<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/710bf3e/src/cli/utils.ts#L62">cli/utils.ts:62</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/710bf3e/src/cli/typescript-starter.ts#L268">cli/typescript-starter.ts:268</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/710bf3e/src/cli/tasks.ts#L183">cli/tasks.ts:183</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/710bf3e/src/cli/tasks.ts#L184">cli/tasks.ts:184</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/710bf3e/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.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/710bf3e/src/cli/tasks.ts#L186">cli/tasks.ts:186</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-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-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">
|
|
<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">
|
|
<a href="globals.html#normalizepath" class="tsd-kind-icon">normalize<wbr>Path</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#readpackagejson" class="tsd-kind-icon">read<wbr>Package<wbr>Json</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">
|
|
<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>
|
|
</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>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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> |