JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec

• Install
• Description
• Usage
  • Constructor properties
• Libp2p Usage Example
• API
  • Transport
  • Connection
• License
• Contribution

$ npm i @libp2p/websockets

libp2p-websockets is the WebSockets implementation compatible with libp2p.

> npm i @libp2p/websockets

import { WebSockets } from '@libp2p/websockets' const properties = { upgrader, filter } const ws = new WebSockets(properties)

You can create your own address filters for this transports, or rely in the filters provided.

The available filters are:

• filters.all
  • Returns all TCP and DNS based addresses, both with ws or wss.
• filters.dnsWss
  • Returns all DNS based addresses with wss.
• filters.dnsWsOrWss
  • Returns all DNS based addresses, both with ws or wss.

import Libp2p from 'libp2p' import { Websockets } from '@libp2p/websockets' import filters from 'libp2p-websockets/filters' import { MPLEX } from 'libp2p-mplex' import { NOISE } from 'libp2p-noise' const transportKey = Websockets.prototype[Symbol.toStringTag] const node = await Libp2p.create({ modules: { transport: [Websockets], streamMuxer: [MPLEX], connEncryption: [NOISE] }, config: { transport: { [transportKey]: { // Transport properties -- Libp2p upgrader is automatically added filter: filters.dnsWsOrWss } } } })

For more information see libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-transports.

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.