MessagePort.emit method | Node.js worker_threads module

MessagePort.emit method | Node.js worker_threads module | BunBuild Docs Reference Guides Blog Discord/node:worker_threads/MessagePort/emitMemit

Search the reference...

Build Docs Reference Guides Blog Discord/node:worker_threads/MessagePort/emitMemit

method

worker_threads.MessagePort.emit emit(event: 'close',ev: Event): boolean;

Node.js-specific extension to the EventTarget class that dispatches the arg to the list of handlers for type.

@returns

true if event listeners registered for the type exist, otherwise false.

emit(event: 'message',value: any): boolean;

Node.js-specific extension to the EventTarget class that dispatches the arg to the list of handlers for type.

@returns

true if event listeners registered for the type exist, otherwise false.

emit(event: 'messageerror',error: Error): boolean;

Node.js-specific extension to the EventTarget class that dispatches the arg to the list of handlers for type.

@returns

true if event listeners registered for the type exist, otherwise false.

emit(event: string,arg: any): boolean;

Node.js-specific extension to the EventTarget class that dispatches the arg to the list of handlers for type.

@returns

true if event listeners registered for the type exist, otherwise false.

Referenced typesclass Event

An event which takes place in the DOM.

MDN Reference

readonly AT_TARGET: 2readonly bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

readonly BUBBLING_PHASE: 3readonly cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

readonly CAPTURING_PHASE: 1readonly composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

readonly currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

readonly defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

readonly eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

readonly isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

readonly NONE: 0readonly target: null | EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

readonly timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

readonly type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

readonly static AT_TARGET: 2readonly static BUBBLING_PHASE: 3readonly static CAPTURING_PHASE: 1readonly static NONE: 0composedPath(): EventTarget[];

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

MDN Reference

preventDefault(): void;

Sets the defaultPrevented property to true if cancelable is true.

stopImmediatePropagation(): void;

Stops the invocation of event listeners after the current one completes.

stopPropagation(): void;

This is not used in Node.js and is provided purely for completeness.

interface Error cause?: unknown

The cause of the error.

message: stringname: stringstack?: string

Resources

Reference Docs Guides Discord Merch Store GitHub Blog