EventSource

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3562

The EventSource interface is web content’s interface to server-sent events.

MDN Reference

Extends

EventTarget

Constructors

Constructor

new EventSource(url, init?): EventSource

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3563

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.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3602

CONNECTING

readonly static CONNECTING: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3600

OPEN

readonly static OPEN: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3601

Accessors

onerror

Get Signature

get onerror(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3597

Returns

any

Set Signature

set onerror(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3599

Parameters

value

any

Returns

void

onmessage

Get Signature

get onmessage(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3593

Returns

any

Set Signature

set onmessage(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3595

Parameters

value

any

Returns

void

onopen

Get Signature

get onopen(): any

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3589

Returns

any

Set Signature

set onopen(value): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3591

Parameters

value

any

Returns

void

readyState

Get Signature

get readyState(): number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3587

The readyState read-only property of the connection.

MDN Reference

Returns

number

url

Get Signature

get url(): string

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3575

The url read-only property of the URL of the source.

MDN Reference

Returns

string

withCredentials

Get Signature

get withCredentials(): boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3581

The withCredentials read-only property of the the EventSource object was instantiated with CORS credentials set.

MDN Reference

Returns

boolean

Methods

addEventListener()

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

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:878

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

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.20251118.0/node_modules/@cloudflare/workers-types/index.ts:3569

The close() method of the EventSource interface closes the connection, if one is made, and sets the js-nolint close() None.

MDN Reference

Returns

void

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:898

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

event

Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

removeEventListener()

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

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:888

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference