worker: graduate BroadcastChannel to supported

.eslintrc.js

@@ -367,6 +367,7 @@ module.exports = {
     Event: 'readable',
     EventTarget: 'readable',
     MessageChannel: 'readable',
+    BroadcastChannel: 'readable',
     MessageEvent: 'readable',
     MessagePort: 'readable',
     TextEncoder: 'readable',

doc/api/globals.md

@@ -229,6 +229,14 @@ added: v16.0.0
 
 Global alias for [`buffer.atob()`][].
 
+## `BroadcastChannel`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+See {BroadcastChannel}.
+
 ## `btoa(data)`
 
 <!-- YAML

doc/api/worker_threads.md

@@ -347,10 +347,12 @@ if (isMainThread) {
 
 <!-- YAML
 added: v15.4.0
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/41271
+    description: No longer experimental.
 -->
 
-> Stability: 1 - Experimental
-
 Instances of `BroadcastChannel` allow asynchronous one-to-many communication
 with all other `BroadcastChannel` instances bound to the same channel name.
 

lib/.eslintrc.yaml

@@ -49,6 +49,8 @@ rules:
       # disabled with --without-intl build flag.
     - name: Intl
       message: "Use `const { Intl } = globalThis;` instead of the global."
+    - name: BroadcastChannel
+      message: "Use `const { BroadcastChannel } = require('internal/worker/io');` instead of the global."
     - name: MessageChannel
       message: "Use `const { MessageChannel } = require('internal/worker/io');` instead of the global."
     - name: MessageEvent

lib/internal/bootstrap/node.js

@@ -251,10 +251,12 @@ if (!config.noBrowserGlobals) {
     MessageChannel,
     MessagePort,
     MessageEvent,
+    BroadcastChannel,
   } = require('internal/worker/io');
   exposeInterface(globalThis, 'MessageChannel', MessageChannel);
   exposeInterface(globalThis, 'MessagePort', MessagePort);
   exposeInterface(globalThis, 'MessageEvent', MessageEvent);
+  exposeInterface(globalThis, 'BroadcastChannel', BroadcastChannel);
 
   // https://html.spec.whatwg.org/multipage/webappapis.html#windoworworkerglobalscope
   const timers = require('timers');

lib/internal/worker/io.js

@@ -395,6 +395,9 @@ function isBroadcastChannel(value) {
 }
 
 class BroadcastChannel extends EventTarget {
+  /**
+   * @param {string} name
+   */
   constructor(name) {
     if (arguments.length === 0)
       throw new ERR_MISSING_ARGS('name');
@@ -426,12 +429,18 @@ class BroadcastChannel extends EventTarget {
     }, opts)}`;
   }
 
+  /**
+   * @type {string}
+   */
   get name() {
     if (!isBroadcastChannel(this))
       throw new ERR_INVALID_THIS('BroadcastChannel');
     return this[kName];
   }
 
+  /**
+   * @returns {void}
+   */
   close() {
     if (!isBroadcastChannel(this))
       throw new ERR_INVALID_THIS('BroadcastChannel');
@@ -445,6 +454,11 @@ class BroadcastChannel extends EventTarget {
     this[kHandle] = undefined;
   }
 
+  /**
+   *
+   * @param {any} message
+   * @returns {void}
+   */
   postMessage(message) {
     if (!isBroadcastChannel(this))
       throw new ERR_INVALID_THIS('BroadcastChannel');
@@ -460,6 +474,9 @@ class BroadcastChannel extends EventTarget {
   // BroadcastChannel API definition. Typically we shouldn't extend Web
   // Platform APIs with Node.js specific methods but ref and unref
   // are a bit special.
+  /**
+   * @returns {BroadcastChannel}
+   */
   ref() {
     if (!isBroadcastChannel(this))
       throw new ERR_INVALID_THIS('BroadcastChannel');
@@ -472,6 +489,9 @@ class BroadcastChannel extends EventTarget {
   // BroadcastChannel API definition. Typically we shouldn't extend Web
   // Platform APIs with Node.js specific methods but ref and unref
   // are a bit special.
+  /**
+   * @returns {BroadcastChannel}
+   */
   unref() {
     if (!isBroadcastChannel(this))
       throw new ERR_INVALID_THIS('BroadcastChannel');