EventSource

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2951

EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

MDN Reference

Extends

EventTarget

Constructors

Constructor

new EventSource(url, init?): EventSource

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2952

Parameters

url

string

init?

EventSourceEventSourceInit

Returns

EventSource

Overrides

EventTarget.constructor

Properties

CLOSED

readonly static CLOSED: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2991

CONNECTING

readonly static CONNECTING: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2989

OPEN

readonly static OPEN: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2990

Accessors

onerror

Get Signature

get onerror(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2986

Returns

any

Set Signature

set onerror(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2988

Parameters

value

any

Returns

void

onmessage

Get Signature

get onmessage(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2982

Returns

any

Set Signature

set onmessage(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2984

Parameters

value

any

Returns

void

onopen

Get Signature

get onopen(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2978

Returns

any

Set Signature

set onopen(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2980

Parameters

value

any

Returns

void

readyState

Get Signature

get readyState(): number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2976

Returns the state of this EventSource object’s connection. It can have the values described below.

MDN Reference

Returns

number

url

Get Signature

get url(): string

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2964

Returns the URL providing the event stream.

MDN Reference

Returns

string

withCredentials

Get Signature

get withCredentials(): boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2970

Returns true if the credentials mode for connection requests to the URL providing the event stream is set to “include”, and false otherwise.

MDN Reference

Returns

boolean

Methods

addEventListener()

addEventListener<Type>(type, handler, options?): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:816

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options’s capture.

When set to true, options’s capture prevents callback from being invoked when the event’s eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event’s eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event’s eventPhase attribute value is AT_TARGET.

When set to true, options’s passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options’s once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options’s signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target’s event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Type Parameters

Type

Type extends string

Parameters

type

Type

handler

EventListenerOrEventListenerObject<Event>

options?

boolean | EventTargetAddEventListenerOptions

Returns

void

Inherited from

EventTarget.addEventListener

close()

close(): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2958

Aborts any instances of the fetch algorithm started for this EventSource object, and sets the readyState attribute to CLOSED.

MDN Reference

Returns

void

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:836

Dispatches a synthetic event event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference