Class WebSocketClientAdapter

Hierarchy

WebSocketNetworkAdapter
- WebSocketClientAdapter

Index

Constructors

constructor

new WebSocketClientAdapter(
url: string,
retryInterval?: number,
): WebSocketClientAdapter
Parameters
- url: string
- OptionalretryInterval: number
Returns WebSocketClientAdapter
Overrides WebSocketNetworkAdapter.constructor
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:13

Properties

onClose

onClose: () => void

onError

onError: () => void

Native WebSocket error events are intentionally opaque — on both the browser and Node the error detail is withheld from scripts by design (https://stackoverflow.com/a/31003057/239663) — so we just log and let the retry logic reconnect.

onMessage

onMessage: (event: MessageEvent) => void

onOpen

onOpen: () => void

`Optional`peerId

peerId?: PeerId

`Optional`peerMetadata

peerMetadata?: PeerMetadata

`Optional`remotePeerId

remotePeerId?: PeerId

`Readonly`retryInterval

retryInterval: number

`Optional`socket

socket?: WebSocket

`Readonly`url

url: string

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends keyof NetworkAdapterEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
          T,
          keyof NetworkAdapterEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from WebSocketNetworkAdapter.addListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

connect

connect(peerId: PeerId, peerMetadata?: PeerMetadata): void
Called by the Repo to start the connection process
Parameters
- peerId: PeerId
  the peerId of this repo
- OptionalpeerMetadata: PeerMetadata
  how this adapter should present itself to other peers
Returns void
Overrides WebSocketNetworkAdapter.connect
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:14

disconnect

disconnect(): void
Called by the Repo to disconnect from the network

Returns void
Overrides WebSocketNetworkAdapter.disconnect
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:24

emit

emit<T extends keyof NetworkAdapterEvents>(
    event: T,
    ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
        T,
        keyof NetworkAdapterEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- ...args: ArgumentMap<NetworkAdapterEvents>[Extract<T, keyof NetworkAdapterEvents>]
Returns boolean
Inherited from WebSocketNetworkAdapter.emit
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof NetworkAdapterEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof NetworkAdapterEvents)[]
Inherited from WebSocketNetworkAdapter.eventNames
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

isReady

isReady(): boolean
Returns boolean
Overrides WebSocketNetworkAdapter.isReady
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:10

join

join(): void
Returns void
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:23

listenerCount

listenerCount(event: keyof NetworkAdapterEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof NetworkAdapterEvents
Returns number
Inherited from WebSocketNetworkAdapter.listenerCount
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof NetworkAdapterEvents>(
    event: T,
): (
    (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void
)[]
Inherited from WebSocketNetworkAdapter.listeners
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof NetworkAdapterEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
          T,
          keyof NetworkAdapterEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from WebSocketNetworkAdapter.off
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof NetworkAdapterEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
          T,
          keyof NetworkAdapterEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from WebSocketNetworkAdapter.on
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof NetworkAdapterEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
          T,
          keyof NetworkAdapterEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from WebSocketNetworkAdapter.once
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:54

peerCandidate

peerCandidate(remotePeerId: PeerId, peerMetadata: PeerMetadata): void
Parameters
- remotePeerId: PeerId
- peerMetadata: PeerMetadata
Returns void
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:26

receiveMessage

receiveMessage(messageBytes: Uint8Array): void
Parameters
- messageBytes: Uint8Array
Returns void
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:27

removeAllListeners

removeAllListeners(event?: keyof NetworkAdapterEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof NetworkAdapterEvents
Returns this
Inherited from WebSocketNetworkAdapter.removeAllListeners
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof NetworkAdapterEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
            T,
            keyof NetworkAdapterEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof NetworkAdapterEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<NetworkAdapterEvents>[Extract<
          T,
          keyof NetworkAdapterEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from WebSocketNetworkAdapter.removeListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

send

send(message: FromClientMessage): void
Called by the Repo to send a message to a peer
Parameters
- message: FromClientMessage
  the message to send
Returns void
Overrides WebSocketNetworkAdapter.send
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:25

whenReady

whenReady(): Promise<void>
Returns Promise<void>
Overrides WebSocketNetworkAdapter.whenReady
- Defined in packages/automerge-repo-network-websocket/dist/WebSocketClientAdapter.d.ts:11

Class WebSocketClientAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketClientAdapter

Properties

onClose

onError

onMessage

onOpen

OptionalpeerId

OptionalpeerMetadata

OptionalremotePeerId

ReadonlyretryInterval

Optionalsocket

Readonlyurl

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Parameters

Returns void

disconnect

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof NetworkAdapterEvents)[]

isReady

Returns boolean

join

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<NetworkAdapterEvents>[Extract< T, keyof NetworkAdapterEvents, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

peerCandidate

Parameters

Returns void

receiveMessage

Parameters

Returns void

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

send

Parameters

Returns void

whenReady

Returns Promise<void>

Settings

`Optional`peerId

`Optional`peerMetadata

`Optional`remotePeerId

`Readonly`retryInterval

`Optional`socket

`Readonly`url

`Static`prefixed

Returns (
(
...args: ArgumentMap<NetworkAdapterEvents>[Extract<
T,
keyof NetworkAdapterEvents,
>],
) => void
)[]