Interface ManagedPeer

Abstraction layer over peerjs' peer. It's supposed to be mockable in future.

It's called ManagedPeer rather than Peer in order not to generate name collision with peerjs.

Hierarchy

ManagedPeer

Implemented by

ManagedPeerJS

Index

Properties

close connect eventBus setConfig stateBus updateConfig

Properties

close

close: (() => void)

Type declaration

- (): void
- Returns void

connect

connect: ((remoteId) => Promise<ManagedPeerDataConnection>)

Type declaration

- (remoteId): Promise<ManagedPeerDataConnection>
- Parameters
  - remoteId: string
  Returns Promise<ManagedPeerDataConnection>

`Readonly` eventBus

eventBus: Subscribable<ManagedPeerEvent>

setConfig

setConfig: ((config) => void)

Type declaration

- (config): void
- Parameters
  - config: ManagedPeerConfig
  Returns void

`Readonly` stateBus

stateBus: StickySubscribable<ManagedPeerState>

updateConfig

updateConfig: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((oldConfig) => ManagedPeerConfig)
    - (oldConfig): ManagedPeerConfig
      
      Parameters
      
      oldConfig: Readonly<ManagedPeerConfig>
      
      Returns ManagedPeerConfig
  Returns void

Generated using TypeDoc