rebuilt cli. Added new vault operations
This commit is contained in:
File diff suppressed because one or more lines are too long
880
docs/classes/keyaction.html
Normal file
880
docs/classes/keyaction.html
Normal file
@@ -0,0 +1,880 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>KeyAction | 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="keyaction.html">KeyAction</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class KeyAction</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">CommandLineAction</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">KeyAction</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="keyaction.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="keyaction.html#_generate" class="tsd-kind-icon">_generate</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="keyaction.html#_privkey" class="tsd-kind-icon">_privkey</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="keyaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="keyaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="keyaction.html#documentation" class="tsd-kind-icon">documentation</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="keyaction.html#summary" class="tsd-kind-icon">summary</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="keyaction.html#parameters" class="tsd-kind-icon">parameters</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</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>Key<wbr>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="keyaction.html" class="tsd-signature-type">KeyAction</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides CommandLineAction.__constructor</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="keyaction.html" class="tsd-signature-type">KeyAction</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="_generate" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _generate</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_generate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineFlagParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_privkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _privkey</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_privkey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_pubkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _pubkey</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_pubkey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:26</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="actionname" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> action<wbr>Name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">action<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#actionname">actionName</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.actionName}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="documentation" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> documentation</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#documentation">documentation</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.documentation}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="summary" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> summary</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">summary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#summary">summary</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.summary}</p>
|
||||
</div>
|
||||
</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="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="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="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 CommandLineAction.onDefineParameters</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:44</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 CommandLineAction.onExecute</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/KeyAction.ts:38</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>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="keyaction.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="keyaction.html#_generate" class="tsd-kind-icon">_generate</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="keyaction.html#_privkey" class="tsd-kind-icon">_privkey</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="keyaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.html#documentation" class="tsd-kind-icon">documentation</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.html#summary" class="tsd-kind-icon">summary</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.html#parameters" class="tsd-kind-icon">parameters</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.html#remainder" class="tsd-kind-icon">remainder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.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="keyaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
<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>
|
||||
1028
docs/classes/opentokencli.html
Normal file
1028
docs/classes/opentokencli.html
Normal file
File diff suppressed because it is too large
Load Diff
936
docs/classes/sendaction.html
Normal file
936
docs/classes/sendaction.html
Normal file
@@ -0,0 +1,936 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SendAction | 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="sendaction.html">SendAction</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class SendAction</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">CommandLineAction</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">SendAction</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="sendaction.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="sendaction.html#_config" class="tsd-kind-icon">_config</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_dryrun" class="tsd-kind-icon">_dryrun</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_force" class="tsd-kind-icon">_force</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_maillist" class="tsd-kind-icon">_maillist</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_safe" class="tsd-kind-icon">_safe</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="sendaction.html#_template" class="tsd-kind-icon">_template</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="sendaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="sendaction.html#documentation" class="tsd-kind-icon">documentation</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="sendaction.html#summary" class="tsd-kind-icon">summary</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="sendaction.html#parameters" class="tsd-kind-icon">parameters</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</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>Send<wbr>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sendaction.html" class="tsd-signature-type">SendAction</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides CommandLineAction.__constructor</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="sendaction.html" class="tsd-signature-type">SendAction</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="_config" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _config</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:28</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_dryrun" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _dryrun</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_dryrun<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineFlagParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:26</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_force" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _force</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_force<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineFlagParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_maillist" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _maillist</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_maillist<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_pubkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _pubkey</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_pubkey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_safe" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _safe</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_safe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_template" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _template</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_template<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:30</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="actionname" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> action<wbr>Name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">action<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#actionname">actionName</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.actionName}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="documentation" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> documentation</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#documentation">documentation</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.documentation}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="summary" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> summary</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">summary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#summary">summary</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.summary}</p>
|
||||
</div>
|
||||
</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="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="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="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 CommandLineAction.onDefineParameters</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:55</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 CommandLineAction.onExecute</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/SendAction.ts:41</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>
|
||||
</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>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="sendaction.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_config" class="tsd-kind-icon">_config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_dryrun" class="tsd-kind-icon">_dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_force" class="tsd-kind-icon">_force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_maillist" class="tsd-kind-icon">_maillist</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_safe" class="tsd-kind-icon">_safe</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="sendaction.html#_template" class="tsd-kind-icon">_template</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.html#documentation" class="tsd-kind-icon">documentation</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.html#summary" class="tsd-kind-icon">summary</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.html#parameters" class="tsd-kind-icon">parameters</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.html#remainder" class="tsd-kind-icon">remainder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.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="sendaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<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>
|
||||
@@ -109,6 +109,7 @@
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#clearvault" class="tsd-kind-icon">clear<wbr>Vault</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#decryptdata" class="tsd-kind-icon">decrypt<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#findstorage" class="tsd-kind-icon">find<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#getallstorage" class="tsd-kind-icon">get<wbr>All<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#loaddata" class="tsd-kind-icon">load<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#pushdata" class="tsd-kind-icon">push<wbr>Data</a></li>
|
||||
@@ -241,7 +242,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:281</li>
|
||||
<li>Defined in src/vault.ts:303</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -257,7 +258,7 @@
|
||||
<a name="decryptdata" class="tsd-anchor"></a>
|
||||
<h3>decrypt<wbr>Data</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Data<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>
|
||||
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Data<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/svault.securevaultitem.html" class="tsd-signature-type">SecureVaultItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
@@ -273,7 +274,7 @@
|
||||
Prints data to console.</p>
|
||||
</div>
|
||||
</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/svault.securevaultitem.html" class="tsd-signature-type">SecureVaultItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Resolves promise after decrypted</p>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -288,7 +289,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:270</li>
|
||||
<li>Defined in src/vault.ts:292</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -310,6 +311,29 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getallstorage" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>All<wbr>Storage</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Storage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/svault.storageitem.html" class="tsd-signature-type">StorageItem</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 src/vault.ts:270</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets all unencrypted data as array.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/svault.storageitem.html" class="tsd-signature-type">StorageItem</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>Data from item.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getstorage" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Storage</h3>
|
||||
@@ -320,7 +344,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:255</li>
|
||||
<li>Defined in src/vault.ts:256</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -417,7 +441,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:221</li>
|
||||
<li>Defined in src/vault.ts:222</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -486,7 +510,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:240</li>
|
||||
<li>Defined in src/vault.ts:241</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -554,7 +578,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:199</li>
|
||||
<li>Defined in src/vault.ts:200</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -586,6 +610,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -625,6 +658,9 @@
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#findstorage" class="tsd-kind-icon">find<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#getallstorage" class="tsd-kind-icon">get<wbr>All<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a>
|
||||
</li>
|
||||
@@ -679,9 +715,19 @@
|
||||
<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>
|
||||
</ul>
|
||||
<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-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>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
|
||||
936
docs/classes/vaultaction.html
Normal file
936
docs/classes/vaultaction.html
Normal file
@@ -0,0 +1,936 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>VaultAction | 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="vaultaction.html">VaultAction</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class VaultAction</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">CommandLineAction</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">VaultAction</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="vaultaction.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="vaultaction.html#_filter" class="tsd-kind-icon">_filter</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_format" class="tsd-kind-icon">_format</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_getcodes" class="tsd-kind-icon">_get<wbr>Codes</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_privkey" class="tsd-kind-icon">_privkey</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_revoke" class="tsd-kind-icon">_revoke</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="vaultaction.html#_safe" class="tsd-kind-icon">_safe</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vaultaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vaultaction.html#documentation" class="tsd-kind-icon">documentation</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vaultaction.html#summary" class="tsd-kind-icon">summary</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="vaultaction.html#parameters" class="tsd-kind-icon">parameters</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</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>Vault<wbr>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vaultaction.html" class="tsd-signature-type">VaultAction</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides CommandLineAction.__constructor</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="vaultaction.html" class="tsd-signature-type">VaultAction</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="_filter" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _filter</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineChoiceParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_format" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _format</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineChoiceParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:30</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_getcodes" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _get<wbr>Codes</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_get<wbr>Codes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineFlagParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_privkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _privkey</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_privkey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_pubkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _pubkey</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_pubkey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:26</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_revoke" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _revoke</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_revoke<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="_safe" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _safe</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_safe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandLineStringParameter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:28</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="actionname" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> action<wbr>Name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">action<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#actionname">actionName</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.actionName}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="documentation" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> documentation</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#documentation">documentation</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.documentation}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="summary" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> summary</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">summary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="keyaction.html">KeyAction</a>.<a href="keyaction.html#summary">summary</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/@rushstack/ts-command-line/dist/ts-command-line.d.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>{@inheritDoc ICommandLineActionOptions.summary}</p>
|
||||
</div>
|
||||
</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="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="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="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 CommandLineAction.onDefineParameters</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:55</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 CommandLineAction.onExecute</p>
|
||||
<ul>
|
||||
<li>Defined in src/cli/VaultAction.ts:41</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>
|
||||
</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>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="vaultaction.html" class="tsd-kind-icon">Vault<wbr>Action</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="vaultaction.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_filter" class="tsd-kind-icon">_filter</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_format" class="tsd-kind-icon">_format</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_getcodes" class="tsd-kind-icon">_get<wbr>Codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_privkey" class="tsd-kind-icon">_privkey</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_pubkey" class="tsd-kind-icon">_pubkey</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_revoke" class="tsd-kind-icon">_revoke</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="vaultaction.html#_safe" class="tsd-kind-icon">_safe</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.html#actionname" class="tsd-kind-icon">action<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.html#documentation" class="tsd-kind-icon">documentation</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.html#summary" class="tsd-kind-icon">summary</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.html#parameters" class="tsd-kind-icon">parameters</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.html#remainder" class="tsd-kind-icon">remainder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.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="vaultaction.html#renderhelptext" class="tsd-kind-icon">render<wbr>Help<wbr>Text</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<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>
|
||||
@@ -71,10 +71,22 @@
|
||||
<h3>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace"><a href="modules/mlgenerator.html" class="tsd-kind-icon">MLGenerator</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/mllogic_key.html" class="tsd-kind-icon">MLLogic_<wbr><wbr>Key</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/mllogic_send.html" class="tsd-kind-icon">MLLogic_<wbr><wbr>Send</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/mllogic_vault.html" class="tsd-kind-icon">MLLogic_<wbr><wbr>Vault</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/mlparser.html" class="tsd-kind-icon">MLParser</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/svault.html" class="tsd-kind-icon">SVault</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class"><a href="classes/keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/vaultaction.html" class="tsd-kind-icon">Vault<wbr>Action</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
@@ -84,15 +96,7 @@
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable"><a href="globals.html#action" class="tsd-kind-icon">action</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#force" class="tsd-kind-icon">force</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#html" class="tsd-kind-icon">html</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#mails" class="tsd-kind-icon">mails</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#commandline" class="tsd-kind-icon">command<wbr>Line</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
@@ -109,92 +113,12 @@
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="action" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> action</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -1</span></div>
|
||||
<a name="commandline" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> command<wbr>Line</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">command<wbr>Line<span class="tsd-signature-symbol">:</span> <a href="classes/opentokencli.html" class="tsd-signature-type">OpenTokenCLI</a><span class="tsd-signature-symbol"> = new OpenTokenCLI()</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="configpath" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> config<wbr>Path</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">config<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="dryrun" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> dryrun</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">dryrun<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="force" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> force</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">force<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="html" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> html</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">html<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="mails" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> mails</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mails<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="privkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> priv<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">priv<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="pubkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> pub<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="safefile" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> safe<wbr>File</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">safe<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
<li>Defined in index.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -307,6 +231,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -317,35 +250,23 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/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#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
<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>
|
||||
@@ -365,9 +286,22 @@
|
||||
<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>
|
||||
|
||||
@@ -243,6 +243,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -253,35 +262,23 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/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#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
<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>
|
||||
@@ -301,9 +298,22 @@
|
||||
<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>
|
||||
|
||||
@@ -141,6 +141,15 @@
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -187,9 +196,22 @@
|
||||
<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>
|
||||
|
||||
@@ -141,6 +141,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -178,9 +187,22 @@
|
||||
<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>
|
||||
|
||||
@@ -110,7 +110,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">dryrun<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:25</li>
|
||||
<li>Defined in src/config.type.ts:43</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -125,7 +125,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">force<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:27</li>
|
||||
<li>Defined in src/config.type.ts:45</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -140,7 +140,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">html<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:16</li>
|
||||
<li>Defined in src/config.type.ts:35</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -155,7 +155,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">in<wbr>File<wbr>Mail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:14</li>
|
||||
<li>Defined in src/config.type.ts:33</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -170,7 +170,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">mail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SMTPTransport</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:8</li>
|
||||
<li>Defined in src/config.type.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -185,7 +185,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">mail<wbr>From<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:10</li>
|
||||
<li>Defined in src/config.type.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -200,7 +200,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">out<wbr>File<wbr>Match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:12</li>
|
||||
<li>Defined in src/config.type.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -215,7 +215,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">used<wbr>Mails<span class="tsd-signature-symbol">:</span> <a href="mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:21</li>
|
||||
<li>Defined in src/config.type.ts:40</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -230,7 +230,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">used<wbr>Tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:19</li>
|
||||
<li>Defined in src/config.type.ts:38</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -251,6 +251,18 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/keyaction.html" class="tsd-kind-icon">Key<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/opentokencli.html" class="tsd-kind-icon">Open<wbr>TokenCLI</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/sendaction.html" class="tsd-kind-icon">Send<wbr>Action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/vaultaction.html" class="tsd-kind-icon">Vault<wbr>Action</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
@@ -288,31 +300,7 @@
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
<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>
|
||||
@@ -332,9 +320,22 @@
|
||||
<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>
|
||||
|
||||
@@ -173,6 +173,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -225,9 +234,22 @@
|
||||
<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>
|
||||
|
||||
@@ -142,6 +142,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -191,9 +200,22 @@
|
||||
<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>
|
||||
|
||||
@@ -157,6 +157,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -206,9 +215,22 @@
|
||||
<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>
|
||||
|
||||
@@ -435,6 +435,15 @@
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -469,9 +478,22 @@
|
||||
<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>
|
||||
|
||||
184
docs/modules/mllogic_key.html
Normal file
184
docs/modules/mllogic_key.html
Normal file
@@ -0,0 +1,184 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLLogic_Key | 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="mllogic_key.html">MLLogic_Key</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLLogic_Key</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for the Key CLI Command.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="mllogic_key.html#generate" class="tsd-kind-icon">generate</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="generate" class="tsd-anchor"></a>
|
||||
<h3>generate</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>privkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/logic/KeyLogic.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>privkey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>pubkey: <span class="tsd-signature-type">string</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">void</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>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mllogic_key.html#generate" class="tsd-kind-icon">generate</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>
|
||||
199
docs/modules/mllogic_send.html
Normal file
199
docs/modules/mllogic_send.html
Normal file
@@ -0,0 +1,199 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLLogic_Send | 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="mllogic_send.html">MLLogic_Send</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLLogic_Send</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for the Send CLI Command.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="mllogic_send.html#send" class="tsd-kind-icon">send</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="send" class="tsd-anchor"></a>
|
||||
<h3>send</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>_force<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, _dryrun<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, _pubkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _safe<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _template<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _maillist<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/logic/SendLogic.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>_force: <span class="tsd-signature-type">boolean</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_dryrun: <span class="tsd-signature-type">boolean</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _pubkey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _config: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _safe: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _template: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _maillist: <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">void</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>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mllogic_send.html#send" class="tsd-kind-icon">send</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>
|
||||
295
docs/modules/mllogic_vault.html
Normal file
295
docs/modules/mllogic_vault.html
Normal file
@@ -0,0 +1,295 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLLogic_Vault | 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="mllogic_vault.html">MLLogic_Vault</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLLogic_Vault</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for the Vault CLI Command.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mllogic_vault.html#getcodes" class="tsd-kind-icon">get<wbr>Codes</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="mllogic_vault.html#open" class="tsd-kind-icon">open</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mllogic_vault.html#printasjson" class="tsd-kind-icon">print<wbr>AsJSON</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mllogic_vault.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="getcodes" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Codes</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Codes<span class="tsd-signature-symbol">(</span>dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a>, _format<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/logic/VaultLogic.ts:96</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_format: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="open" class="tsd-anchor"></a>
|
||||
<h3>open</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">open<span class="tsd-signature-symbol">(</span>_filter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _pubkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _privkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _safe<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _getCodes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, _format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _revoke<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">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 src/logic/VaultLogic.ts:29</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _filter: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _pubkey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _privkey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _safe: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_getCodes: <span class="tsd-signature-type">boolean</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _format: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_revoke: <span class="tsd-signature-type">string</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">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 tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="printasjson" class="tsd-anchor"></a>
|
||||
<h3>print<wbr>AsJSON</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">print<wbr>AsJSON<span class="tsd-signature-symbol">(</span>_filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a>, vault<span class="tsd-signature-symbol">: </span><a href="../interfaces/svault.securevaultitem.html" class="tsd-signature-type">SecureVaultItem</a><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">
|
||||
<ul>
|
||||
<li>Defined in src/logic/VaultLogic.ts:51</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>_filter: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>vault: <a href="../interfaces/svault.securevaultitem.html" class="tsd-signature-type">SecureVaultItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="revoketoken" class="tsd-anchor"></a>
|
||||
<h3>revoke<wbr>Token</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">revoke<wbr>Token<span class="tsd-signature-symbol">(</span>dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a>, _revoke<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _safe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/logic/VaultLogic.ts:69</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_revoke: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>_safe: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</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>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mllogic_vault.html#getcodes" class="tsd-kind-icon">get<wbr>Codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mllogic_vault.html#open" class="tsd-kind-icon">open</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mllogic_vault.html#printasjson" class="tsd-kind-icon">print<wbr>AsJSON</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mllogic_vault.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</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>
|
||||
@@ -148,6 +148,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -173,9 +182,22 @@
|
||||
<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>
|
||||
|
||||
@@ -128,6 +128,15 @@
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_key.html">MLLogic_<wbr><wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_send.html">MLLogic_<wbr><wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mllogic_vault.html">MLLogic_<wbr><wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
@@ -162,9 +171,22 @@
|
||||
<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>
|
||||
|
||||
Reference in New Issue
Block a user