Class PluginChannel

A channel communicating with a counterpart in a plugin host.

Implements

DebugChannel

Index

Constructors

Properties

Methods

close fireClosed fireError fireMessageReceived onClose onError onMessage send

Constructors

constructor

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

Properties

`Protected` `Readonly`connection

connection: ConnectionExt | ConnectionMain

`Protected` `Readonly`id

id: 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: unknown): void
Parameters
- error: unknown
Returns void
- Defined in packages/plugin-ext/src/common/connection.ts:40

fireMessageReceived

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

onClose

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

onError

onError(cb: (reason: any) => void): void
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- cb: (reason: any) => void
Returns void
Implementation of DebugChannel.onError
- Defined in packages/plugin-ext/src/common/connection.ts:53

onMessage

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

send

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