doc: fix event.cancelBubble documentation

Setter of `event.cancelBubble` is a no-op if the value passed to it is not `true`. Refs: https://dom.spec.whatwg.org/#interface-event PR-URL: #45986 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · Jan 20, 2023 · 76408bc · 76408bc
1 parent 82023f2
commit 76408bc
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/doc/api/events.md b/doc/api/events.md
@@ -1748,14 +1748,16 @@ added: v14.5.0
 
 This is not used in Node.js and is provided purely for completeness.
 
-#### `event.cancelBubble()`
+#### `event.cancelBubble`
 
 <!-- YAML
 added: v14.5.0
 -->
 
-Alias for `event.stopPropagation()`. This is not used in Node.js and is
-provided purely for completeness.
+* Type: {boolean}
+
+Alias for `event.stopPropagation()` if set to `true`. This is not used
+in Node.js and is provided purely for completeness.
 
 #### `event.cancelable`