worker: expose BroadcastChannel as a global

jasnell · jasnell · commit ce4d3adf5029 · 2021-12-24T08:32:48.000-08:00
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #41271 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -368,6 +368,7 @@ module.exports = {
     Event: 'readable',
     EventTarget: 'readable',
     MessageChannel: 'readable',
+    BroadcastChannel: 'readable',
     MessageEvent: 'readable',
     MessagePort: 'readable',
     TextEncoder: 'readable',
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -239,6 +239,14 @@ added: v16.0.0
 
 Global alias for [`buffer.atob()`][].
 
+## `BroadcastChannel`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+See {BroadcastChannel}.
+
 ## `btoa(data)`
 
 <!-- YAML
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
@@ -349,7 +349,7 @@ if (isMainThread) {
 added: v15.4.0
 changes:
   - version: REPLACEME
-    pr-url: https://github.com/nodejs/node/pull/00000
+    pr-url: https://github.com/nodejs/node/pull/41271
     description: No longer experimental.
 -->
 
diff --git a/lib/.eslintrc.yaml b/lib/.eslintrc.yaml
@@ -51,6 +51,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
diff --git a/lib/internal/bootstrap/node.js b/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');
diff --git a/lib/internal/worker/io.js b/lib/internal/worker/io.js
@@ -456,7 +456,7 @@ class BroadcastChannel extends EventTarget {
 
   /**
    *
-   * @param {*} message
+   * @param {any} message
    * @returns {void}
    */
   postMessage(message) {

Original file line number	Diff line number	Diff line change
`@@ -456,7 +456,7 @@ class BroadcastChannel extends EventTarget {`
`456`	`456`
`457`	`457`	`/**`
`458`	`458`	`*`
`459`		`- * @param {*} message`
	`459`	`+ * @param {any} message`
`460`	`460`	`* @returns {void}`
`461`	`461`	`*/`
`462`	`462`	`postMessage(message) {`