Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessagePort

Defines a class that allows messages sent from one port to be recieved at the other port.

Hierarchy

  • MessagePort

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MessagePort(channelID: number | string): MessagePort

Properties

Private _channelId

_channelId: number | string

The ID of this message port's channel.

Private _listeners

_listeners: OnMessageListener[]

The "message" listeners.

Private _other

_other: MessagePort

The other message port.

Private _sendMessage

_sendMessage: (data: any, transfer: Transferrable[]) => void

The function that should be called to send a message to the remote.

Type declaration

Private _transferred

_transferred: boolean

Whether this message port has been transferred.

onmessage

onmessage: (e: MessageEvent) => void = null

Represents an event handler for the "message" event, that is a function to be called when a message is recieved from the worker.

Type declaration

Accessors

channelID

  • get channelID(): string | number

transferred

  • get transferred(): boolean

Methods

Private _recieveMessage

  • _recieveMessage(data: any): void

addEventListener

close

  • close(): void

postMessage

removeEventListener

start

  • start(): void

transfer

  • transfer(sendMessage: (data: any, transfer: Transferrable[]) => void): (data: any) => void

Static link

Generated using TypeDoc