code refactoring and added extensive documentation
This commit is contained in:
484
docs/modules/mlgenerator.html
Normal file
484
docs/modules/mlgenerator.html
Normal file
@@ -0,0 +1,484 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLGenerator | 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="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLGenerator</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 Generating the Code and delivering the mails</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>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-kind-icon">MLGen<wbr>Return</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<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="mlgenerator.html#generatecodes" class="tsd-kind-icon">generate<wbr>Codes</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="mlgenerator.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mlgenerator.html#send" class="tsd-kind-icon">send</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mlgenerator.html#sendmails" class="tsd-kind-icon">send<wbr>Mails</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="generatecodes" class="tsd-anchor"></a>
|
||||
<h3>generate<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">generate<wbr>Codes<span class="tsd-signature-symbol">(</span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, mailArray<span class="tsd-signature-symbol">: </span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:79</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Generate the same amout of codes as distinct mail adresses and stores them to the list file
|
||||
This function also includes previously used tokens to prevent duplicate tokens.
|
||||
Rejects if matchfile cannot be saved.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>resolve: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to resolve promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><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">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to reject promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailArray: <a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of mail adresses</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
usedTokens -> List of previosly used tokens
|
||||
outFileMatch -> Path to match file</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">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">
|
||||
<a name="generatetoken" class="tsd-anchor"></a>
|
||||
<h3>generate<wbr>Token</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">generate<wbr>Token<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</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/generate.ts:56</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Main function used to generate and deliver codes</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>used codes and processed mails</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="send" class="tsd-anchor"></a>
|
||||
<h3>send</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<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">HandlebarsTemplateDelegate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, mailserver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mail</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:206</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reads template file and compiles template.
|
||||
Iterate through mails and codes, randomly assign code to mail and send mail to recipient.
|
||||
If dryrun is enabled, mails will not be sent and new mails won't be included in return.
|
||||
Rejects if template cannot be read.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Name of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mail: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Mail of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Code of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>template: <span class="tsd-signature-type">HandlebarsTemplateDelegate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>compiled mail template</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailserver: <span class="tsd-signature-type">Mail</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Mailserver settings</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
mail.auth.user -> sender mail adress
|
||||
mailFrom -> sender mail ailas
|
||||
dryrun -> Boolean value. If true no mails will be sent.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">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="sendmails" class="tsd-anchor"></a>
|
||||
<h3>send<wbr>Mails</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">send<wbr>Mails<span class="tsd-signature-symbol">(</span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, mailArray<span class="tsd-signature-symbol">: </span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span>, codeArray<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:138</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reads template file and compiles template.
|
||||
Iterate through mails and codes, randomly assign code to mail and send mail to recipient.
|
||||
If dryrun is enabled, mails will not be sent and new mails won't be included in return.
|
||||
Rejects if template cannot be read.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>resolve: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to resolve promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><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">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to reject promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailArray: <a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of mail adresses</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>codeArray: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of generated codes</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
htmlPath -> Path to html template
|
||||
dryrun -> Boolean value. If true no mails will be sent and list won't be updated.
|
||||
force -> Boolean value. If true all mails are resent.
|
||||
usedTokens -> Array of Strings. Specifies already used tokens adresses.
|
||||
usedMails -> Array of Strings. Specifies already served mail adresses.
|
||||
mail -> mailserver settings</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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="current tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</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-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-kind-icon">MLGen<wbr>Return</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#generatecodes" class="tsd-kind-icon">generate<wbr>Codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mlgenerator.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#send" class="tsd-kind-icon">send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#sendmails" class="tsd-kind-icon">send<wbr>Mails</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-interface"><span class="tsd-kind-icon">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>
|
||||
Reference in New Issue
Block a user