Class MessageChannelNetworkAdapter

An interface representing some way to connect to other peers

Remarks

The Repo uses one or more NetworkAdapters to connect to other peers. Because the network may take some time to be ready the Repo will wait until the adapter emits a ready event before it starts trying to use it

This utility class can be used as a base to build a custom network adapter. It is most useful as a simple way to add the necessary event emitter functionality

Hierarchy (View Summary)

NetworkAdapter
- MessageChannelNetworkAdapter

Index

Constructors

constructor

new MessageChannelNetworkAdapter(
messagePort: MessagePort,
config?: MessageChannelNetworkAdapterConfig,
): MessageChannelNetworkAdapter
Parameters
- messagePort: MessagePort
- config: MessageChannelNetworkAdapterConfig = {}
Returns MessageChannelNetworkAdapter
Overrides NetworkAdapter.constructor
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:49

Properties

channels

channels: {} = {}

`Optional`peerId

peerId?: PeerId

`Optional`peerMetadata

peerMetadata?: PeerMetadata

`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 NetworkAdapter.addListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

announceConnection

announceConnection(peerId: PeerId, peerMetadata: PeerMetadata): void
Parameters
- peerId: PeerId
- peerMetadata: PeerMetadata
Returns void
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:158

connect

connect(peerId: PeerId, peerMetadata?: PeerMetadata): void
Called by the Repo to start the connection process
Parameters
- peerId: PeerId
- OptionalpeerMetadata: PeerMetadata
Returns void
Argument
peerId - the peerId of this repo

Argument
peerMetadata - how this adapter should present itself to other peers
Overrides NetworkAdapter.connect
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:62

disconnect

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

Returns void
Overrides NetworkAdapter.disconnect
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:164

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 NetworkAdapter.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 NetworkAdapter.eventNames
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

isReady

isReady(): boolean
Returns boolean
Overrides NetworkAdapter.isReady
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:34

listenerCount

listenerCount(event: keyof NetworkAdapterEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof NetworkAdapterEvents
Returns number
Inherited from NetworkAdapter.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 NetworkAdapter.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 NetworkAdapter.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 NetworkAdapter.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 NetworkAdapter.once
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof NetworkAdapterEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof NetworkAdapterEvents
Returns this
Inherited from NetworkAdapter.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 NetworkAdapter.removeListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

send

send(message: RepoMessage): void
Called by the Repo to send a message to a peer
Parameters
- message: RepoMessage
Returns void
Argument
message - the message to send
Overrides NetworkAdapter.send
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:139

whenReady

whenReady(): Promise<void>
Returns Promise<void>
Overrides NetworkAdapter.whenReady
- Defined in packages/automerge-repo-network-messagechannel/src/index.ts:38

Class MessageChannelNetworkAdapter

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MessageChannelNetworkAdapter

Properties

channels

OptionalpeerId

OptionalpeerMetadata

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

announceConnection

Parameters

Returns void

connect

Parameters

Returns void

Argument

Argument

disconnect

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof NetworkAdapterEvents)[]

isReady

Returns boolean

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

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

send

Parameters

Returns void

Argument

whenReady

Returns Promise<void>

Settings

On This Page

`Optional`peerId

`Optional`peerMetadata

`Static`prefixed

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