Class PluginConnection

The container for message reader and writer which can be used to create connection between plugins and main side.

Hierarchy

PluginConnection

Implements

Connection

Index

Constructors

constructor

Properties

Methods

forward

Constructors

constructor

new PluginConnection(reader: PluginMessageReader, writer: PluginMessageWriter, dispose: () => void): PluginConnection

- Defined in packages/plugin-ext/src/common/connection.ts:39
Parameters
- reader: PluginMessageReader
- writer: PluginMessageWriter
- dispose: () => void
  - - (): void
    - Returns void
Returns PluginConnection

Properties

Readonly dispose

dispose: () => void

Type declaration

- (): void
- Returns void

Readonly reader

reader: PluginMessageReader

Readonly writer

writer: PluginMessageWriter

Methods

forward

forward(to: Connection, map?: (message: Message) => Message): void

Implementation of Connection.forward
- Defined in packages/plugin-ext/src/common/connection.ts:46
Allows to forward messages to another connection.

Parameters
- to: Connection
- map: (message: Message) => Message = ...
  - - (message: Message): Message
    - Parameters
      - message: Message
      Returns Message
Returns void