2021-09-27 22:11:35 +03:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > @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" >
< h1 > @fluencelabs/fluence< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< div class = "tsd-panel tsd-typography" >
< a href = "#fluence-js" id = "fluence-js" style = "color: inherit; text-decoration: none;" >
< h1 > Fluence JS< / h1 >
< / a >
< p > To start developing applications with Fluence JS refer to the official < a href = "https://doc.fluence.dev/docs/js-sdk" > documentation< / a > < / p >
< p > Fluence JS is an implementation of the Fluence protocol for JavaScript-based environments. It can connect browsers, Node.js applications, and so on to the Fluence p2p network.< / p >
< p > Similar to the < a href = "https://github.com/fluencelabs/fluence" > Rust Fluence Peer implementation< / a > it includes:< / p >
< ul >
< li > Peer-to-peer communication layer (via < a href = "https://github.com/libp2p/js-libp2p" > js-libp2p< / a > )< / li >
< li > < a href = "https://github.com/fluencelabs/aquavm" > Aqua VM< / a > < / li >
< li > Builtin services< / li >
< / ul >
< p > Fluence JS can call services and functions on the Fluence network, and expose new APIs to the p2p network directly from TypeScript and JavaScript.
< a href = "https://github.com/fluencelabs/aqua" > Aqua language< / a > uses Fluence JS as a compilation target, and they are designed to < a href = "https://doc.fluence.dev/docs/js-sdk/3_in_depth#understanding-the-aqua-compiler-output" > work in tandem< / a > .< / p >
< p > Fluence JS can be used with any framework of your choice (or even without frameworks).< / p >
< / div >
< / 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 = "interfaces/CallParams.html" class = "tsd-kind-icon" > Call< wbr > Params< / a >
< / li >
2021-10-21 18:04:20 +03:00
< li class = " tsd-kind-interface" >
< a href = "interfaces/PeerConfig.html" class = "tsd-kind-icon" > Peer< wbr > Config< / a >
< / li >
2021-09-27 22:11:35 +03:00
< li class = " tsd-kind-interface" >
< a href = "interfaces/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 >
