@joergmittaglawo/dmvconfig

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>src/run/heads | @joergmittaglawo/dmvconfig</title> <meta name="description" content="Documentation for @joergmittaglawo/dmvconfig"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </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">@joergmittaglawo/dmvconfig</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> </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="../modules.html">@joergmittaglawo/dmvconfig</a> </li> <li> <a href="src_run_heads.html">src/run/heads</a> </li> </ul> <h1>Module src/run/heads</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>Runs the Heads Configuration</p> </div> <dl class="tsd-comment-tags"> <dt>version</dt> <dd><p>0.0.0-alpha.0</p> </dd> <dt>date</dt> <dd><p>2020-10-13</p> </dd> <dt>author</dt> <dd><p>Mittag, Jörg (Lawo) <a href="mailto:joerg.mittag@lawo.com">joerg.mittag@lawo.com</a></p> </dd> <dt>license</dt> <dd><p>SPDX-License-Identifier: MIT</p> </dd> <dt>changelog</dt> <dd><p>2020-10-13 JMi Add support for tally rules</p> </dd> <dt>changelog</dt> <dd><p>2020-10-10 JMi Add support for background images</p> </dd> <dt>changelog</dt> <dd><p>2020-10-10 JMi Implement support for PPMs</p> </dd> <dt>changelog</dt> <dd><p>2020-10-10 JMi Make unnecessary members optional</p> </dd> </dl> </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>References</h3> <ul class="tsd-index-list"> <li class="tsd-kind-reference tsd-parent-kind-module"><a href="src_run_heads.html#default" class="tsd-kind-icon">default</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-module"><a href="src_run_heads.html#runheadconfig" class="tsd-kind-icon">run<wbr>Head<wbr>Config</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>References</h2> <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"> <a name="default" class="tsd-anchor"></a> <h3>default</h3> Renames and exports <a href="src_run_heads.html#runheadconfig">runHeadConfig</a> </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-module"> <a name="runheadconfig" class="tsd-anchor"></a> <h3>run<wbr>Head<wbr>Config</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">run<wbr>Head<wbr>Config<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>__date__<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cluster<span class="tsd-signature-symbol">: </span><a href="config_config_cluster.html#clusterconfig" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterConfig</a><span class="tsd-signature-symbol">; </span>heads<span class="tsd-signature-symbol">: </span><a href="config_config_heads.html#headsconfig" class="tsd-signature-type" data-tsd-kind="Type alias">HeadsConfig</a><span class="tsd-signature-symbol">; </span>masterScriptIp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>monitoringObjects<span class="tsd-signature-symbol">: </span><a href="config_config_monitoring_objects.html#mosconfig" class="tsd-signature-type" data-tsd-kind="Type alias">MosConfig</a><span class="tsd-signature-symbol">; </span>nodes<span class="tsd-signature-symbol">: </span><a href="config_config_nodes.html#nodesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">NodesConfig</a><span class="tsd-signature-symbol">; </span>pip<span class="tsd-signature-symbol">: </span><a href="config_config_pip.html#pipconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PipConfig</a><span class="tsd-signature-symbol">; </span>ptp<span class="tsd-signature-symbol">: </span><a href="config_config_ptp.html#ptpconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PtpConfig</a><span class="tsd-signature-symbol">; </span>sources<span class="tsd-signature-symbol">: </span><a href="config_config_sources.html#sourcesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">SourcesConfig</a><span class="tsd-signature-symbol"> }</span>, master<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VMatrix</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 <a href="https://github.com/JoergMittagLawo/DMV-Configuration/blob/93ce944/src/run/heads.ts#L27">src/run/heads.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Runs the Heads Configuration</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>__date__<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cluster<span class="tsd-signature-symbol">: </span><a href="config_config_cluster.html#clusterconfig" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterConfig</a><span class="tsd-signature-symbol">; </span>heads<span class="tsd-signature-symbol">: </span><a href="config_config_heads.html#headsconfig" class="tsd-signature-type" data-tsd-kind="Type alias">HeadsConfig</a><span class="tsd-signature-symbol">; </span>masterScriptIp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>monitoringObjects<span class="tsd-signature-symbol">: </span><a href="config_config_monitoring_objects.html#mosconfig" class="tsd-signature-type" data-tsd-kind="Type alias">MosConfig</a><span class="tsd-signature-symbol">; </span>nodes<span class="tsd-signature-symbol">: </span><a href="config_config_nodes.html#nodesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">NodesConfig</a><span class="tsd-signature-symbol">; </span>pip<span class="tsd-signature-symbol">: </span><a href="config_config_pip.html#pipconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PipConfig</a><span class="tsd-signature-symbol">; </span>ptp<span class="tsd-signature-symbol">: </span><a href="config_config_ptp.html#ptpconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PtpConfig</a><span class="tsd-signature-symbol">; </span>sources<span class="tsd-signature-symbol">: </span><a href="config_config_sources.html#sourcesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">SourcesConfig</a><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>__date__<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>cluster<span class="tsd-signature-symbol">: </span><a href="config_config_cluster.html#clusterconfig" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterConfig</a></h5> </li> <li class="tsd-parameter"> <h5>heads<span class="tsd-signature-symbol">: </span><a href="config_config_heads.html#headsconfig" class="tsd-signature-type" data-tsd-kind="Type alias">HeadsConfig</a></h5> </li> <li class="tsd-parameter"> <h5>master<wbr>Script<wbr>Ip<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>monitoring<wbr>Objects<span class="tsd-signature-symbol">: </span><a href="config_config_monitoring_objects.html#mosconfig" class="tsd-signature-type" data-tsd-kind="Type alias">MosConfig</a></h5> </li> <li class="tsd-parameter"> <h5>nodes<span class="tsd-signature-symbol">: </span><a href="config_config_nodes.html#nodesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">NodesConfig</a></h5> </li> <li class="tsd-parameter"> <h5>pip<span class="tsd-signature-symbol">: </span><a href="config_config_pip.html#pipconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PipConfig</a></h5> </li> <li class="tsd-parameter"> <h5>ptp<span class="tsd-signature-symbol">: </span><a href="config_config_ptp.html#ptpconfig" class="tsd-signature-type" data-tsd-kind="Type alias">PtpConfig</a></h5> </li> <li class="tsd-parameter"> <h5>sources<span class="tsd-signature-symbol">: </span><a href="config_config_sources.html#sourcesconfig" class="tsd-signature-type" data-tsd-kind="Type alias">SourcesConfig</a></h5> </li> </ul> </li> <li> <h5>master: <span class="tsd-signature-type">VMatrix</span></h5> <div class="tsd-comment tsd-typography"> <p>An open VMatrix connection to the cluster master</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=" "> <a href="../modules.html">Modules</a> </li> <li class="current tsd-kind-module"> <a href="src_run_heads.html">src/run/heads</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-reference tsd-parent-kind-module"> <a href="src_run_heads.html#default" class="tsd-kind-icon">default</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="src_run_heads.html#runheadconfig" class="tsd-kind-icon">run<wbr>Head<wbr>Config</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-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</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>