Interface BroadcastChannel

    MDN Reference

    interface BroadcastChannel {
        name: string;
        onmessage: (this: BroadcastChannel, ev: MessageEvent) => any;
        onmessageerror: (this: BroadcastChannel, ev: MessageEvent) => any;
        addEventListener<K extends keyof BroadcastChannelEventMap>(
            type: K,
            listener: (this: BroadcastChannel, ev: BroadcastChannelEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(): void;
        dispatchEvent(event: Event): boolean;
        postMessage(message: any): void;
        removeEventListener<K extends keyof BroadcastChannelEventMap>(
            type: K,
            listener: (this: BroadcastChannel, ev: BroadcastChannelEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }
    Hierarchy

    Properties

    name onmessage onmessageerror

    Methods

    addEventListener close dispatchEvent postMessage removeEventListener

    Properties

    Readonlyname

    name: string

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

    MDN Reference

    onmessage

    onmessage: (this: BroadcastChannel, ev: MessageEvent) => any

    MDN Reference

    onmessageerror

    onmessageerror: (this: BroadcastChannel, ev: MessageEvent) => any

    MDN Reference

    Methods

    addEventListener

    • addEventListener<K extends keyof BroadcastChannelEventMap>(
          type: K,
          listener: (this: BroadcastChannel, ev: BroadcastChannelEventMap[K]) => any,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      Parameters

      Returns void

    • addEventListener(
          type: string,
          listener: EventListenerOrEventListenerObject,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    close

    • close(): void

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

      MDN Reference

      Returns void

    dispatchEvent

    • dispatchEvent(event: Event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    postMessage

    • 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.

      MDN Reference

      Parameters

      • message: any

      Returns void

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Properties
    Methods