Class PluginChannel

A channel communicating with a counterpart in a plugin host.

Implements

DebugChannel

Index

Constructors

Properties

closedEmitter connection errorEmitter id messageEmitter

Methods

close fireClosed fireError fireMessageReceived onClose onError onMessage send

Constructors

constructor

new PluginChannel(id, connection): PluginChannel
Parameters
- id: string
- connection: ConnectionMain | ConnectionExt
Returns PluginChannel
- Defined in packages/plugin-ext/src/common/connection.ts:28

Properties

`Private` closedEmitter

closedEmitter: Emitter<void> = ...

`Protected` `Readonly` connection

connection: ConnectionMain | ConnectionExt

`Private` errorEmitter

errorEmitter: Emitter<unknown> = ...

`Protected` `Readonly` id

id: string

`Private` messageEmitter

messageEmitter: Emitter<string> = ...

Methods

close

close(): void
Returns void
Implementation of DebugChannel.close
- Defined in packages/plugin-ext/src/common/connection.ts:61

fireClosed

fireClosed(): void
Returns void
- Defined in packages/plugin-ext/src/common/connection.ts:44

fireError

fireError(error): void
Parameters
- error: unknown
Returns void
- Defined in packages/plugin-ext/src/common/connection.ts:40

fireMessageReceived

fireMessageReceived(msg): void
Parameters
- msg: string
Returns void
- Defined in packages/plugin-ext/src/common/connection.ts:36

onClose

onClose(cb): void
Parameters
- cb: ((code, reason) => void)
  - - (code, reason): void
    - Parameters
      code: number
      reason: string
      Returns void
Returns void
Implementation of DebugChannel.onClose
- Defined in packages/plugin-ext/src/common/connection.ts:57

onError

onError(cb): void
Parameters
- cb: ((reason) => void)
  - - (reason): void
    - Parameters
      reason: any
      Returns void
Returns void
Implementation of DebugChannel.onError
- Defined in packages/plugin-ext/src/common/connection.ts:53

onMessage

onMessage(cb): void
Parameters
- cb: ((message) => void)
  - - (message): void
    - Parameters
      message: string
      Returns void
Returns void
Implementation of DebugChannel.onMessage
- Defined in packages/plugin-ext/src/common/connection.ts:48

send

send(content): void
Parameters
- content: string
Returns void
Implementation of DebugChannel.send
- Defined in packages/plugin-ext/src/common/connection.ts:32