Interface Port

ReadonlythreadId

close

• close(): void

  Destroy the communication channel.

  Returns void

on

• on<T>(
      event: string,
      codec: Codec<T>,
      callback: (msg: Envelope<T>) => void,
  ): () => void

  Attach event listener for particular event.

  Returns a function that can be called to unsubscribe.

  Type Parameters

  • T

  Parameters

  • event: string
  • codec: Codec<T>
  • callback: (msg: Envelope<T>) => void

  Returns () => void

once

• once<T>(
      event: string,
      codec: Codec<T>,
      callback: (msg: Envelope<T>) => void,
  ): () => void

  Attach one-time event listener for particular event.

  Returns a function that can be called to unsubscribe.

  Type Parameters

  • T

  Parameters

  • event: string
  • codec: Codec<T>
  • callback: (msg: Envelope<T>) => void

  Returns () => void

onClose

• onClose(callback: (e: Error) => void): void

  Attach a callback to be triggered when the port is being closed (via error or not).

  Parameters

  • callback: (e: Error) => void

  Returns void

postMessage

• postMessage<T>(event: string, codec: Codec<T>, msg: Envelope<T>): void

  Post a message to the port that should be received on the other end.

  Type Parameters

  • T

  Parameters

  • event: string
  • codec: Codec<T>
  • msg: Envelope<T>

  Returns void