Package Exports

@libp2p/websockets
@libp2p/websockets/filters

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@libp2p/websockets) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@libp2p/websockets

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

About

A libp2p transport based on WebSockets.

Example

import { createLibp2p } from 'libp2p'
import { webSockets } from '@libp2p/websockets'
import { multiaddr } from '@multiformats/multiaddr'

const node = await createLibp2p({
  transports: [
    webSockets()
  ]
//... other config
})
await node.start()

const ma = multiaddr('/dns4/example.com/tcp/9090/tls/ws')
await node.dial(ma)

Install

$ npm i @libp2p/websockets

Browser `<script>` tag

Loading this module through a script tag will make its exports available as Libp2pWebsockets in the global namespace.

<script src="https://unpkg.com/@libp2p/websockets/dist/index.min.js"></script>

API Docs

https://libp2p.github.io/js-libp2p/modules/_libp2p_websockets.html

License

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)

Contribution

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.