<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>PeerConfig | @fluencelabs/fluence</title> <meta name="description" content="Documentation for @fluencelabs/fluence"> <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">@fluencelabs/fluence</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">@fluencelabs/fluence</a> </li> <li> <a href="PeerConfig.html">PeerConfig</a> </li> </ul> <h1>Interface PeerConfig</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>Configuration used when initiating Fluence Peer</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">PeerConfig</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="PeerConfig.html#KeyPair" class="tsd-kind-icon">Key<wbr>Pair</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#avmLogLevel" class="tsd-kind-icon">avm<wbr>Log<wbr>Level</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#checkConnectionTimeoutMs" class="tsd-kind-icon">check<wbr>Connection<wbr>Timeout<wbr>Ms</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#connectTo" class="tsd-kind-icon">connect<wbr>To</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#defaultTtlMs" class="tsd-kind-icon">default<wbr>Ttl<wbr>Ms</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#dialTimeoutMs" class="tsd-kind-icon">dial<wbr>Timeout<wbr>Ms</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerConfig.html#skipCheckConnection" class="tsd-kind-icon">skip<wbr>Check<wbr>Connection</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="KeyPair" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> Key<wbr>Pair</h3> <div class="tsd-signature tsd-kind-icon">Key<wbr>Pair<span class="tsd-signature-symbol">:</span> <a href="../classes/KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L77">internal/FluencePeer.ts:77</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specify the KeyPair to be used to identify the Fluence Peer. Will be generated randomly if not specified</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="avmLogLevel" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> avm<wbr>Log<wbr>Level</h3> <div class="tsd-signature tsd-kind-icon">avm<wbr>Log<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LogLevel</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L71">internal/FluencePeer.ts:71</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specify log level for Aqua VM running on the peer</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="checkConnectionTimeoutMs" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr>Connection<wbr>Timeout<wbr>Ms</h3> <div class="tsd-signature tsd-kind-icon">check<wbr>Connection<wbr>Timeout<wbr>Ms<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/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L84">internal/FluencePeer.ts:84</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When the peer established the connection to the network it sends a ping-like message to check if it works correctly. The options allows to specify the timeout for that message in milliseconds. If not specified the default timeout will be used</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="connectTo" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> connect<wbr>To</h3> <div class="tsd-signature tsd-kind-icon">connect<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Multiaddr</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Node</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L66">internal/FluencePeer.ts:66</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Node in Fluence network to connect to. Can be in the form of:</p> <ul> <li>string: multiaddr in string format</li> <li>Multiaddr: multiaddr object, @see <a href="https://github.com/multiformats/js-multiaddr">https://github.com/multiformats/js-multiaddr</a></li> <li>Node: node structure, @see Node If not specified the will work locally and would not be able to send or receive particles.</li> </ul> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="defaultTtlMs" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Ttl<wbr>Ms</h3> <div class="tsd-signature tsd-kind-icon">default<wbr>Ttl<wbr>Ms<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/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L103">internal/FluencePeer.ts:103</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets the default TTL for all particles originating from the peer with no TTL specified. If the originating particle's TTL is defined then that value will be used If the option is not set default TTL will be 7000</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="dialTimeoutMs" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> dial<wbr>Timeout<wbr>Ms</h3> <div class="tsd-signature tsd-kind-icon">dial<wbr>Timeout<wbr>Ms<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/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L96">internal/FluencePeer.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The dialing timeout in milliseconds</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="skipCheckConnection" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> skip<wbr>Check<wbr>Connection</h3> <div class="tsd-signature tsd-kind-icon">skip<wbr>Check<wbr>Connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L91">internal/FluencePeer.ts:91</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When the peer established the connection to the network it sends a ping-like message to check if it works correctly. If set to true, the ping-like message will be skipped Default: false</p> </div> </div> </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> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="../classes/FluencePeer.html" class="tsd-kind-icon">Fluence<wbr>Peer</a> </li> <li class=" tsd-kind-class"> <a href="../classes/KeyPair.html" class="tsd-kind-icon">Key<wbr>Pair</a> </li> <li class=" tsd-kind-interface tsd-has-type-parameter"> <a href="CallParams.html" class="tsd-kind-icon">Call<wbr>Params</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#KeyPair" class="tsd-kind-icon">Key<wbr>Pair</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#avmLogLevel" class="tsd-kind-icon">avm<wbr>Log<wbr>Level</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#checkConnectionTimeoutMs" class="tsd-kind-icon">check<wbr>Connection<wbr>Timeout<wbr>Ms</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#connectTo" class="tsd-kind-icon">connect<wbr>To</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#defaultTtlMs" class="tsd-kind-icon">default<wbr>Ttl<wbr>Ms</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#dialTimeoutMs" class="tsd-kind-icon">dial<wbr>Timeout<wbr>Ms</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="PeerConfig.html#skipCheckConnection" class="tsd-kind-icon">skip<wbr>Check<wbr>Connection</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface"> <a href="PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a> </li> <li class=" tsd-kind-type-alias"> <a href="../modules.html#AvmLoglevel" class="tsd-kind-icon">Avm<wbr>Loglevel</a> </li> <li class=" tsd-kind-type-alias"> <a href="../modules.html#PeerIdB58" class="tsd-kind-icon">Peer<wbr>IdB58</a> </li> <li class=" tsd-kind-variable"> <a href="../modules.html#Fluence" class="tsd-kind-icon">Fluence</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#setLogLevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</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-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> </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-static"><span class="tsd-kind-icon">Static method</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>