admin/moloch---sliver-script
1
0
Fork 0
mirror of https://github.com/moloch--/sliver-script synced 2026-06-08 16:08:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
pure-ts
moloch---sliver-script/docs/modules/config.html
T
moloch-- f7ee24f053 updated docs
2021-07-04 10:42:12 -05:00

243 lines
11 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>config | sliver-script</title>
<meta name="description" content="Documentation for sliver-script">
<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">sliver-script</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>
</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">sliver-script</a>
</li>
<li>
<a href="config.html">config</a>
</li>
</ul>
<h1>Module config</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/config.sliverclientconfig.html" class="tsd-kind-icon">Sliver<wbr>Client<wbr>Config</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="config.html#listconfigs" class="tsd-kind-icon">List<wbr>Configs</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="config.html#parseconfig" class="tsd-kind-icon">Parse<wbr>Config</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="config.html#parseconfigfile" class="tsd-kind-icon">Parse<wbr>Config<wbr>File</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-module">
<a name="listconfigs" class="tsd-anchor"></a>
<h3>List<wbr>Configs</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">List<wbr>Configs<span class="tsd-signature-symbol">(</span>configDir<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/moloch--/sliver-script/blob/cf08424/src/config.ts#L40">src/config.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>configDir: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="parseconfig" class="tsd-anchor"></a>
<h3>Parse<wbr>Config</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">Parse<wbr>Config<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/moloch--/sliver-script/blob/cf08424/src/config.ts#L36">src/config.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="parseconfigfile" class="tsd-anchor"></a>
<h3>Parse<wbr>Config<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">Parse<wbr>Config<wbr>File<span class="tsd-signature-symbol">(</span>filePath<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/moloch--/sliver-script/blob/cf08424/src/config.ts#L13">src/config.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/config.sliverclientconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">SliverClientConfig</a><span class="tsd-signature-symbol">&gt;</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">Exports</a>
</li>
<li class=" tsd-kind-module">
<a href="client.html">client</a>
</li>
<li class="current tsd-kind-module">
<a href="config.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="events.html">events</a>
</li>
<li class=" tsd-kind-module">
<a href="index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="pb_clientpb_client_pb.html">pb/clientpb/client_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="pb_commonpb_common_pb.html">pb/commonpb/common_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="pb_rpcpb_services_grpc_pb.html">pb/rpcpb/services_<wbr>grpc_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="pb_rpcpb_services_pb.html">pb/rpcpb/services_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="pb_sliverpb_sliver_pb.html">pb/sliverpb/sliver_<wbr>pb</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/config.sliverclientconfig.html" class="tsd-kind-icon">Sliver<wbr>Client<wbr>Config</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="config.html#listconfigs" class="tsd-kind-icon">List<wbr>Configs</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="config.html#parseconfig" class="tsd-kind-icon">Parse<wbr>Config</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="config.html#parseconfigfile" class="tsd-kind-icon">Parse<wbr>Config<wbr>File</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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 View Git Blame Copy Permalink