@cityofzion/neo-js
Version:
Running NEO blockchain full node with Node.js and MongoDB.
370 lines • 21.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>MeshOptions | @cityofzion/neo-js</title>
<meta name="description" content="">
<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.js" 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">@cityofzion/neo-js</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="../modules/_core_mesh_.html">"core/mesh"</a>
</li>
<li>
<a href="_core_mesh_.meshoptions.html">MeshOptions</a>
</li>
</ul>
<h1>Interface MeshOptions</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="target">MeshOptions</span>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#benchmarkintervalms" class="tsd-kind-icon">benchmark<wbr>Interval<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#fetchmissinguseragentintervalms" class="tsd-kind-icon">fetch<wbr>Missing<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#loggeroptions" class="tsd-kind-icon">logger<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#minactivenodesrequired" class="tsd-kind-icon">min<wbr>Active<wbr>Nodes<wbr>Required</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#pendingrequeststhreshold" class="tsd-kind-icon">pending<wbr>Requests<wbr>Threshold</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#refreshuseragentintervalms" class="tsd-kind-icon">refresh<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#startbenchmarkoninit" class="tsd-kind-icon">start<wbr>Benchmark<wbr>OnInit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_core_mesh_.meshoptions.html#tofetchuseragent" class="tsd-kind-icon">to<wbr>Fetch<wbr>User<wbr>Agent</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="benchmarkintervalms" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> benchmark<wbr>Interval<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">benchmark<wbr>Interval<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L21">core/mesh.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fetchmissinguseragentintervalms" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fetch<wbr>Missing<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">fetch<wbr>Missing<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L22">core/mesh.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="loggeroptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> logger<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">logger<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LoggerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L26">core/mesh.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="minactivenodesrequired" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Active<wbr>Nodes<wbr>Required</h3>
<div class="tsd-signature tsd-kind-icon">min<wbr>Active<wbr>Nodes<wbr>Required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L24">core/mesh.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pendingrequeststhreshold" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pending<wbr>Requests<wbr>Threshold</h3>
<div class="tsd-signature tsd-kind-icon">pending<wbr>Requests<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L25">core/mesh.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="refreshuseragentintervalms" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> refresh<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">refresh<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L23">core/mesh.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="startbenchmarkoninit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>Benchmark<wbr>OnInit</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Benchmark<wbr>OnInit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L19">core/mesh.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tofetchuseragent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> to<wbr>Fetch<wbr>User<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">to<wbr>Fetch<wbr>User<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CityOfZion/neo-js/blob/87cbcb8/src/core/mesh.ts#L20">core/mesh.ts:20</a></li>
</ul>
</aside>
</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-external-module">
<a href="../modules/_analyzers_block_analyzer_.html">"analyzers/block-<wbr>analyzer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_common_constants_.html">"common/constants"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_common_profiles_.html">"common/profiles"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_core_api_.html">"core/api"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_core_mesh_.html">"core/mesh"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_core_node_.html">"core/node"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_core_syncer_.html">"core/syncer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_delegates_rpc_delegate_.html">"delegates/rpc-<wbr>delegate"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_helpers_block_helper_.html">"helpers/block-<wbr>helper"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_neo_.html">"neo"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_memory_storage_.html">"storages/memory-<wbr>storage"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_storage_.html">"storages/mongodb-<wbr>storage"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_block_dao_.html">"storages/mongodb/block-<wbr>dao"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_block_meta_dao_.html">"storages/mongodb/block-<wbr>meta-<wbr>dao"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_schemas_.html">"storages/mongodb/schemas"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_transaction_meta_dao_.html">"storages/mongodb/transaction-<wbr>meta-<wbr>dao"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_storages_mongodb_utils_.html">"storages/mongodb/utils"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_validators_endpoint_validator_.html">"validators/endpoint-<wbr>validator"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_validators_mongodb_validator_.html">"validators/mongodb-<wbr>validator"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_validators_neo_validator_.html">"validators/neo-<wbr>validator"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_validators_rpc_validator_.html">"validators/rpc-<wbr>validator"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/_core_mesh_.mesh.html" class="tsd-kind-icon">Mesh</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_core_mesh_.meshoptions.html" class="tsd-kind-icon">Mesh<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#benchmarkintervalms" class="tsd-kind-icon">benchmark<wbr>Interval<wbr>Ms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#fetchmissinguseragentintervalms" class="tsd-kind-icon">fetch<wbr>Missing<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#loggeroptions" class="tsd-kind-icon">logger<wbr>Options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#minactivenodesrequired" class="tsd-kind-icon">min<wbr>Active<wbr>Nodes<wbr>Required</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#pendingrequeststhreshold" class="tsd-kind-icon">pending<wbr>Requests<wbr>Threshold</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#refreshuseragentintervalms" class="tsd-kind-icon">refresh<wbr>User<wbr>Agent<wbr>Interval<wbr>Ms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#startbenchmarkoninit" class="tsd-kind-icon">start<wbr>Benchmark<wbr>OnInit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_core_mesh_.meshoptions.html#tofetchuseragent" class="tsd-kind-icon">to<wbr>Fetch<wbr>User<wbr>Agent</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_core_mesh_.html#module_name" class="tsd-kind-icon">MODULE_<wbr>NAME</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_core_mesh_.html#default_options" class="tsd-kind-icon">DEFAULT_<wbr>OPTIONS</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</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>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>