diff options
Diffstat (limited to 'doc/api/events.md')
| -rw-r--r-- | doc/api/events.md | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/api/events.md b/doc/api/events.md index d008b95641e..39950b5c12f 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -939,7 +939,7 @@ composed of the emitted event arguments. ## `EventTarget` and `Event` API <!-- YAML -added: REPLACEME +added: v14.5.0 --> > Stability: 1 - Experimental @@ -1056,7 +1056,7 @@ The `EventTarget` does not implement any special default handling for ### Class: `Event` <!-- YAML -added: REPLACEME +added: v14.5.0 --> The `Event` object is an adaptation of the [`Event` Web API][]. Instances @@ -1064,7 +1064,7 @@ are created internally by Node.js. #### `event.bubbles` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} Always returns `false`. @@ -1073,7 +1073,7 @@ This is not used in Node.js and is provided purely for completeness. #### `event.cancelBubble()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> Alias for `event.stopPropagation()`. This is not used in Node.js and is @@ -1081,14 +1081,14 @@ provided purely for completeness. #### `event.cancelable` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} True if the event was created with the `cancelable` option. #### `event.composed` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} Always returns `false`. @@ -1097,7 +1097,7 @@ This is not used in Node.js and is provided purely for completeness. #### `event.composedPath()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> Returns an array containing the current `EventTarget` as the only entry or @@ -1106,7 +1106,7 @@ Node.js and is provided purely for completeness. #### `event.currentTarget` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {EventTarget} The `EventTarget` dispatching the event. @@ -1115,7 +1115,7 @@ Alias for `event.target`. #### `event.defaultPrevented` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} @@ -1125,7 +1125,7 @@ called. #### `event.eventPhase` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {number} Returns `0` while an event is not being dispatched, `2` while @@ -1135,7 +1135,7 @@ This is not used in Node.js and is provided purely for completeness. #### `event.isTrusted` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} Always returns `false`. @@ -1144,14 +1144,14 @@ This is not used in Node.js and is provided purely for completeness. #### `event.preventDefault()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> Sets the `defaultPrevented` property to `true` if `cancelable` is `true`. #### `event.returnValue` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {boolean} True if the event has not been canceled. @@ -1160,7 +1160,7 @@ This is not used in Node.js and is provided purely for completeness. #### `event.srcElement` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {EventTarget} The `EventTarget` dispatching the event. @@ -1169,28 +1169,28 @@ Alias for `event.target`. #### `event.stopImmediatePropagation()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> Stops the invocation of event listeners after the current one completes. #### `event.stopPropagation()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> This is not used in Node.js and is provided purely for completeness. #### `event.target` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {EventTarget} The `EventTarget` dispatching the event. #### `event.timeStamp` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {number} @@ -1199,7 +1199,7 @@ The millisecond timestamp when the `Event` object was created. #### `event.type` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Type: {string} @@ -1208,12 +1208,12 @@ The event type identifier. ### Class: `EventTarget` <!-- YAML -added: REPLACEME +added: v14.5.0 --> #### `eventTarget.addEventListener(type, listener[, options])` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1255,7 +1255,7 @@ target.removeEventListener('foo', handler, { capture: true }); #### `eventTarget.dispatchEvent(event)` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `event` {Object|Event} @@ -1269,7 +1269,7 @@ were registered. #### `eventTarget.removeEventListener(type, listener)` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1281,7 +1281,7 @@ Removes the `listener` from the list of handlers for event `type`. ### Class: `NodeEventTarget` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Extends: {EventTarget} @@ -1291,7 +1291,7 @@ that emulates a subset of the `EventEmitter` API. #### `nodeEventTarget.addListener(type, listener[, options])` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1308,7 +1308,7 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and #### `nodeEventTarget.eventNames()` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * Returns: {string[]} @@ -1318,7 +1318,7 @@ of event `type` names for which event listeners are registered. #### `nodeEventTarget.listenerCount(type)` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1330,7 +1330,7 @@ of event listeners registered for the `type`. #### `nodeEventTarget.off(type, listener)` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1342,7 +1342,7 @@ Node.js-speciic alias for `eventTarget.removeListener()`. #### `nodeEventTarget.on(type, listener[, options])` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1356,7 +1356,7 @@ Node.js-specific alias for `eventTarget.addListener()`. #### `nodeEventTarget.once(type, listener[, options])` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1371,7 +1371,7 @@ with the `once` option set to `true`. #### `nodeEventTarget.removeAllListeners([type])` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} @@ -1382,7 +1382,7 @@ listeners. #### `nodeEventTarget.removeListener(type, listener)` <!-- YAML -added: REPLACEME +added: v14.5.0 --> * `type` {string} |