Skip to main content

Messaging

Facilitate communication between different parts of an application, allowing data exchange and coordination.

Eg BroadcastChannel, MessageChannel

Interfaces

I
v
BroadcastChannel

Represents a named channel that any BroadcastChannel with the same name (across workers or isolates in the same Deno process) can use to send and receive messages, allowing one-to-many communication between execution contexts.

I
v
MessageChannel

The MessageChannel interface of the Channel Messaging API allows us to create a new message channel and send data through it via its two MessagePort properties.

I
v
MessagePort

The MessagePort interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.

I
MessagePortEventMap
No documentation available

interface BroadcastChannel

extends EventTarget

Represents a named channel that any BroadcastChannel with the same name (across workers or isolates in the same Deno process) can use to send and receive messages, allowing one-to-many communication between execution contexts.

Properties #

#name: string
readonly

Returns the channel name (as passed to the constructor).

#onmessage: (() => any) | null
#onmessageerror: (() => any) | null

Methods #

#close(): void

Closes the BroadcastChannel object, opening it up to garbage collection.

#postMessage(message: any): void

Sends the given message to other BroadcastChannel objects set up for this channel. Messages can be structured objects, e.g. nested objects and arrays.

#addEventListener<K extends keyof BroadcastChannelEventMap>(
type: K,
listener: () => any,
options?: boolean | AddEventListenerOptions,
): void
#addEventListener(
type: string,
options?: boolean | AddEventListenerOptions,
): void
#removeEventListener<K extends keyof BroadcastChannelEventMap>(
type: K,
listener: () => any,
options?: boolean | EventListenerOptions,
): void
#removeEventListener(
type: string,
options?: boolean | EventListenerOptions,
): void

variable BroadcastChannel

The constructor object for BroadcastChannel.

Construct a channel with new BroadcastChannel(name) to join the channel identified by name; messages posted on it are delivered to every other BroadcastChannel connected to the same name.

Properties #



interface MessageChannel

The MessageChannel interface of the Channel Messaging API allows us to create a new message channel and send data through it via its two MessagePort properties.

Properties #

variable MessageChannel

The MessageChannel interface of the Channel Messaging API allows us to create a new message channel and send data through it via its two MessagePort properties.

Properties #


interface MessagePort

extends EventTarget

The MessagePort interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.

Properties #

#onmessage: (() => any) | null
#onmessageerror: (() => any) | null

Methods #

#close(): void

Disconnects the port, so that it is no longer active.

#postMessage(
message: any,
transfer: Transferable[],
): void

Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side.

Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned.

#postMessage(
message: any,
): void
#start(): void

Begins dispatching messages received on the port. This is implicitly called when assigning a value to this.onmessage.

#addEventListener<K extends keyof MessagePortEventMap>(
type: K,
listener: () => any,
options?: boolean | AddEventListenerOptions,
): void
#addEventListener(
type: string,
options?: boolean | AddEventListenerOptions,
): void
#removeEventListener<K extends keyof MessagePortEventMap>(
type: K,
listener: () => any,
options?: boolean | EventListenerOptions,
): void
#removeEventListener(
type: string,
options?: boolean | EventListenerOptions,
): void

variable MessagePort

The MessagePort interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.

Properties #



Did you find what you needed?

Privacy policy