1028 lines
57 KiB
HTML
1028 lines
57 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>OpenTokenCLI | opentoken</title>
|
|
<meta name="description" content="Documentation for opentoken">
|
|
<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.json" 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">opentoken</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="opentokencli.html">OpenTokenCLI</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class OpenTokenCLI</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="tsd-signature-type">CommandLineParser</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">OpenTokenCLI</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="opentokencli.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="opentokencli.html#_verbose" class="tsd-kind-icon">_verbose</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#selectedaction" class="tsd-kind-icon">selected<wbr>Action</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-inherited">
|
|
<h3>Accessors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#actions" class="tsd-kind-icon">actions</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#parameters" class="tsd-kind-icon">parameters</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#remainder" class="tsd-kind-icon">remainder</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#addaction" class="tsd-kind-icon">add<wbr>Action</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#definechoiceparameter" class="tsd-kind-icon">define<wbr>Choice<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#definecommandlineremainder" class="tsd-kind-icon">define<wbr>Command<wbr>Line<wbr>Remainder</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#defineflagparameter" class="tsd-kind-icon">define<wbr>Flag<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#defineintegerparameter" class="tsd-kind-icon">define<wbr>Integer<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#definestringlistparameter" class="tsd-kind-icon">define<wbr>String<wbr>List<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#definestringparameter" class="tsd-kind-icon">define<wbr>String<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#execute" class="tsd-kind-icon">execute</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#executewithouterrorhandling" class="tsd-kind-icon">execute<wbr>Without<wbr>Error<wbr>Handling</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getaction" class="tsd-kind-icon">get<wbr>Action</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getchoiceparameter" class="tsd-kind-icon">get<wbr>Choice<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getflagparameter" class="tsd-kind-icon">get<wbr>Flag<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getintegerparameter" class="tsd-kind-icon">get<wbr>Integer<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getstringlistparameter" class="tsd-kind-icon">get<wbr>String<wbr>List<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#getstringparameter" class="tsd-kind-icon">get<wbr>String<wbr>Parameter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="opentokencli.html#ondefineparameters" class="tsd-kind-icon">on<wbr>Define<wbr>Parameters</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="opentokencli.html#onexecute" class="tsd-kind-icon">on<wbr>Execute</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="opentokencli.html#trygetaction" class="tsd-kind-icon">try<wbr>Get<wbr>Action</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Open<wbr>TokenCLI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="opentokencli.html" class="tsd-signature-type">OpenTokenCLI</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Overrides CommandLineParser.__constructor</p>
|
|
<ul>
|
|
<li>Defined in src/cli/OpenTokenCLI.ts:27</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="opentokencli.html" class="tsd-signature-type">OpenTokenCLI</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="_verbose" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _verbose</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineFlagParameter</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in src/cli/OpenTokenCLI.ts:27</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="selectedaction" class="tsd-anchor"></a>
|
|
<h3>selected<wbr>Action</h3>
|
|
<div class="tsd-signature tsd-kind-icon">selected<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineAction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#selectedaction">selectedAction</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:383</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Reports which CommandLineAction was specified on the command line.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>The value will be assigned before onExecute() is invoked.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
|
<h2>Accessors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="actions" class="tsd-anchor"></a>
|
|
<h3>actions</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> actions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">CommandLineAction</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#actions">actions</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:395</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the list of actions that were defined for this CommandLineParser object.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">CommandLineAction</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="parameters" class="tsd-anchor"></a>
|
|
<h3>parameters</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> parameters<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">CommandLineParameter</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#parameters">parameters</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:229</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns a collection of the parameters that were defined for this object.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">CommandLineParameter</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="remainder" class="tsd-anchor"></a>
|
|
<h3>remainder</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> remainder<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineRemainder</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#remainder">remainder</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:234</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,
|
|
this object captures any remaining command line arguments after the recognized portion.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineRemainder</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="addaction" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Action</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Action<span class="tsd-signature-symbol">(</span>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineAction</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">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#addaction">addAction</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:399</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a new action that can be used with the CommandLineParser instance.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>action: <span class="tsd-signature-type">CommandLineAction</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="definechoiceparameter" class="tsd-anchor"></a>
|
|
<h3>define<wbr>Choice<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>Choice<wbr>Parameter<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineChoiceDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineChoiceParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#definechoiceparameter">defineChoiceParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:245</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a command-line parameter whose value must be a string from a fixed set of
|
|
allowable choices (similar to an enum).</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>Example of a choice parameter:</p>
|
|
<pre><code><span class="hljs-built_in">example</span>-tool --<span class="hljs-built_in">log</span>-level warn</code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineChoiceDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineChoiceParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="definecommandlineremainder" class="tsd-anchor"></a>
|
|
<h3>define<wbr>Command<wbr>Line<wbr>Remainder</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>Command<wbr>Line<wbr>Remainder<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineRemainderDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineRemainder</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#definecommandlineremainder">defineCommandLineRemainder</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:327</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a rule that captures any remaining command line arguments after the recognized portion.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This feature is useful for commands that pass their arguments along to an external tool, relying on
|
|
that tool to perform validation. (It could also be used to parse parameters without any validation
|
|
or documentation, but that is not recommended.)</p>
|
|
<p>Example of capturing the remainder after an optional flag parameter.</p>
|
|
<pre><code>example-tool --my-flag <span class="hljs-keyword">this</span> <span class="hljs-keyword">is</span> the remainder</code></pre>
|
|
<p>In the "--help" documentation, the remainder rule will be represented as "...".</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineRemainderDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineRemainder</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="defineflagparameter" class="tsd-anchor"></a>
|
|
<h3>define<wbr>Flag<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>Flag<wbr>Parameter<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineFlagDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineFlagParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#defineflagparameter">defineFlagParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:262</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a command-line switch whose boolean value is true if the switch is provided,
|
|
and false otherwise.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>Example usage of a flag parameter:</p>
|
|
<pre><code>example-tool <span class="hljs-comment">--debug</span></code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineFlagDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineFlagParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="defineintegerparameter" class="tsd-anchor"></a>
|
|
<h3>define<wbr>Integer<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>Integer<wbr>Parameter<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineIntegerDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineIntegerParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#defineintegerparameter">defineIntegerParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:278</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a command-line parameter whose argument is an integer.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>Example usage of an integer parameter:</p>
|
|
<pre><code><span class="hljs-built_in">example</span>-tool --<span class="hljs-built_in">max</span>-attempts <span class="hljs-number">5</span></code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineIntegerDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineIntegerParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="definestringlistparameter" class="tsd-anchor"></a>
|
|
<h3>define<wbr>String<wbr>List<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>String<wbr>List<wbr>Parameter<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineStringListDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineStringListParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#definestringlistparameter">defineStringListParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:311</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a command-line parameter whose argument is a single text string. The parameter can be
|
|
specified multiple times to build a list.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>Example usage of a string list parameter:</p>
|
|
<pre><code>example-tool --<span class="hljs-builtin-name">add</span> file1.txt --<span class="hljs-builtin-name">add</span> file2.txt --<span class="hljs-builtin-name">add</span> file3.txt</code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineStringListDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineStringListParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="definestringparameter" class="tsd-anchor"></a>
|
|
<h3>define<wbr>String<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">define<wbr>String<wbr>Parameter<span class="tsd-signature-symbol">(</span>definition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ICommandLineStringDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandLineStringParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#definestringparameter">defineStringParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:294</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a command-line parameter whose argument is a single text string.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>Example usage of a string parameter:</p>
|
|
<pre><code>example-tool --<span class="hljs-keyword">message</span> <span class="hljs-string">"Hello, world!"</span></code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>definition: <span class="tsd-signature-type">ICommandLineStringDefinition</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineStringParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="execute" class="tsd-anchor"></a>
|
|
<h3>execute</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#execute">execute</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:427</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The program entry point will call this method to begin parsing command-line arguments
|
|
and executing the corresponding action.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>The returned promise will never reject: If an error occurs, it will be printed
|
|
to stderr, process.exitCode will be set to 1, and the promise will resolve to false.
|
|
This simplifies the most common usage scenario where the program entry point doesn't
|
|
want to be involved with the command-line logic, and will discard the promise without
|
|
a then() or catch() block.</p>
|
|
<p>If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}
|
|
instead.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> args: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the command-line arguments to be parsed; if omitted, then
|
|
the process.argv will be used</p>
|
|
</div>
|
|
</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">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="executewithouterrorhandling" class="tsd-anchor"></a>
|
|
<h3>execute<wbr>Without<wbr>Error<wbr>Handling</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">execute<wbr>Without<wbr>Error<wbr>Handling<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-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">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#executewithouterrorhandling">executeWithoutErrorHandling</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:432</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This is similar to {@link CommandLineParser.execute}, except that execution errors
|
|
simply cause the promise to reject. It is the caller's responsibility to trap</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> args: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getaction" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Action</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Action<span class="tsd-signature-symbol">(</span>actionName<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">CommandLineAction</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#getaction">getAction</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:404</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the action with the specified name. If no matching action is found,
|
|
an exception is thrown.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>actionName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineAction</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getchoiceparameter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Choice<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Choice<wbr>Parameter<span class="tsd-signature-symbol">(</span>parameterLongName<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">CommandLineChoiceParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#getchoiceparameter">getChoiceParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:251</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the CommandLineChoiceParameter with the specified long name.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This method throws an exception if the parameter is not defined.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>parameterLongName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineChoiceParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getflagparameter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Flag<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Flag<wbr>Parameter<span class="tsd-signature-symbol">(</span>parameterLongName<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">CommandLineFlagParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#getflagparameter">getFlagParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:268</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the CommandLineFlagParameter with the specified long name.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This method throws an exception if the parameter is not defined.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>parameterLongName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineFlagParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getintegerparameter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Integer<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Integer<wbr>Parameter<span class="tsd-signature-symbol">(</span>parameterLongName<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">CommandLineIntegerParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#getintegerparameter">getIntegerParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:284</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the CommandLineIntegerParameter with the specified long name.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This method throws an exception if the parameter is not defined.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>parameterLongName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineIntegerParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getstringlistparameter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>String<wbr>List<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>String<wbr>List<wbr>Parameter<span class="tsd-signature-symbol">(</span>parameterLongName<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">CommandLineStringListParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#getstringlistparameter">getStringListParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:333</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the CommandLineStringListParameter with the specified long name.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This method throws an exception if the parameter is not defined.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>parameterLongName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineStringListParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getstringparameter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>String<wbr>Parameter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>String<wbr>Parameter<span class="tsd-signature-symbol">(</span>parameterLongName<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">CommandLineStringParameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#getstringparameter">getStringParameter</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:300</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns the CommandLineStringParameter with the specified long name.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>remarks</dt>
|
|
<dd><p>This method throws an exception if the parameter is not defined.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>parameterLongName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineStringParameter</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<a name="ondefineparameters" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> on<wbr>Define<wbr>Parameters</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Define<wbr>Parameters<span class="tsd-signature-symbol">(</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">
|
|
<p>Overrides CommandLineParameterProvider.onDefineParameters</p>
|
|
<ul>
|
|
<li>Defined in src/cli/OpenTokenCLI.ts:40</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<a name="onexecute" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> on<wbr>Execute</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Execute<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">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Overrides CommandLineParser.onExecute</p>
|
|
<ul>
|
|
<li>Defined in src/cli/OpenTokenCLI.ts:48</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="renderhelptext" class="tsd-anchor"></a>
|
|
<h3>render<wbr>Help<wbr>Text</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">render<wbr>Help<wbr>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#renderhelptext">renderHelpText</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:337</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates the command-line help text.</p>
|
|
</div>
|
|
</div>
|
|
<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-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="trygetaction" class="tsd-anchor"></a>
|
|
<h3>try<wbr>Get<wbr>Action</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">try<wbr>Get<wbr>Action<span class="tsd-signature-symbol">(</span>actionName<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">CommandLineAction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="opentokencli.html">OpenTokenCLI</a>.<a href="opentokencli.html#trygetaction">tryGetAction</a></p>
|
|
<ul>
|
|
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:409</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the action with the specified name. If no matching action is found,
|
|
undefined is returned.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>actionName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CommandLineAction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class">
|
|
<a href="keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class">
|
|
<a href="opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<a href="opentokencli.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="opentokencli.html#_verbose" class="tsd-kind-icon">_verbose</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#selectedaction" class="tsd-kind-icon">selected<wbr>Action</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#actions" class="tsd-kind-icon">actions</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#parameters" class="tsd-kind-icon">parameters</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#remainder" class="tsd-kind-icon">remainder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#addaction" class="tsd-kind-icon">add<wbr>Action</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#definechoiceparameter" class="tsd-kind-icon">define<wbr>Choice<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#definecommandlineremainder" class="tsd-kind-icon">define<wbr>Command<wbr>Line<wbr>Remainder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#defineflagparameter" class="tsd-kind-icon">define<wbr>Flag<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#defineintegerparameter" class="tsd-kind-icon">define<wbr>Integer<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#definestringlistparameter" class="tsd-kind-icon">define<wbr>String<wbr>List<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#definestringparameter" class="tsd-kind-icon">define<wbr>String<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#execute" class="tsd-kind-icon">execute</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#executewithouterrorhandling" class="tsd-kind-icon">execute<wbr>Without<wbr>Error<wbr>Handling</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getaction" class="tsd-kind-icon">get<wbr>Action</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getchoiceparameter" class="tsd-kind-icon">get<wbr>Choice<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getflagparameter" class="tsd-kind-icon">get<wbr>Flag<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getintegerparameter" class="tsd-kind-icon">get<wbr>Integer<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getstringlistparameter" class="tsd-kind-icon">get<wbr>String<wbr>List<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#getstringparameter" class="tsd-kind-icon">get<wbr>String<wbr>Parameter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<a href="opentokencli.html#ondefineparameters" class="tsd-kind-icon">on<wbr>Define<wbr>Parameters</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
|
<a href="opentokencli.html#onexecute" class="tsd-kind-icon">on<wbr>Execute</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="opentokencli.html#trygetaction" class="tsd-kind-icon">try<wbr>Get<wbr>Action</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class">
|
|
<a href="sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="vaultaction.html" class="tsd-kind-icon">Vault<wbr>Action</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/otglobalconfig.html" class="tsd-kind-icon">OTGlobal<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="../globals.html#commandline" class="tsd-kind-icon">command<wbr>Line</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="../globals.html#delay" class="tsd-kind-icon">delay</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="../globals.html#mkstringcn" class="tsd-kind-icon">mkstringCN</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="../globals.html#shufflearray" class="tsd-kind-icon">shuffle<wbr>Array</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-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>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</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>
|
|
</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>
|
|
</body>
|
|
</html> |