Home Manual Reference Source Repository

NPM Join the chat at https://gitter.im/coast-team/netflux semantic-release Commitizen friendly 

Dependency Status  devDependency Status  optionalDependencies Status

Build Status  bitHound Overall Score  Code Climate  Test Coverage  Documentation

Abstract peer to peer transport API for client and server.

Permit to create a fully connected peer to peer network based on WebRTC and WebSocket.

Allows to send/receive the following data types over the network: String, ArrayBuffer, TypedArray.

Table of contents

Full documentation: https://doc.esdoc.org/github.com/coast-team/netflux


create function is the start point, unless you are developing a peer bot, then consider using BotServer (see below). create functions return an object of type WebChannel which represents the peer to peer network.

dist/netflux.es2015.es.js and dist/netflux.es5.umd.minjs both exports: