libp2p-websockets 0.15.2

libp2p-websockets

0.15.2

WebSockets ▸
- Instance members
- #dial
- #createListener
- #filter

Need help reading this?

WebSockets

src/index.js

new WebSockets()

Instance Members

▸ dial(ma, options = {})

src/index.js

dial(ma: Multiaddr, options: object?): Connection

Parameters

ma (Multiaddr)

options

(object?
            = {})

Name	Description
options.signal `AbortSignal?`	Used to abort dial requests

Returns

Connection: An upgraded Connection

▸ createListener(options = {}, handler)

src/index.js

Creates a Websockets listener. The provided handler function will be called anytime a new incoming Connection has been successfully upgraded via upgrader.upgradeInbound.

createListener(options: object?, handler: function (Connection)): Listener

Parameters

options

(object?
            = {})

Name	Description
options.server `http.Server?`	A pre-created Node.js HTTP/S server.

handler (function (Connection))

Returns

Listener: A Websockets listener

▸ filter(multiaddrs)

src/index.js

Takes a list of Multiaddrs and returns only valid Websockets addresses. By default, in a browser environment only DNS+WSS multiaddr is accepted, while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.

filter(multiaddrs: Array<Multiaddr>): Array<Multiaddr>

Parameters

multiaddrs (Array<Multiaddr>)

Returns

Array<Multiaddr>: Valid Websockets multiaddrs