Class SseClient

A client for the server-sent events protocol.

Hierarchy

EventTarget
- SseClient

Implements

MessageClient

Index

Accessors

isConnected url

Methods

addEventListener close connect dispatchEvent removeEventListener send simulateError simulateMessage create createNull

Accessors

isConnected

get isConnected(): boolean
Return whether the client is connected.

Returns boolean
Implementation of MessageClient.isConnected
- Defined in src/infrastructure/sse_client.ts:36

url

get url(): string | undefined
Return the server URL.

Returns string | undefined
Implementation of MessageClient.url
- Defined in src/infrastructure/sse_client.ts:40

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): void
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
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Implementation of MessageClient.addEventListener
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14380

close

close(): Promise<void>
Close the connection.

Returns Promise<void>
Implementation of MessageClient.close
- Defined in src/infrastructure/sse_client.ts:82

connect

connect(
    url: string | URL,
    eventName?: string,
    ...otherEvents: string[],
): Promise<void>
Connect to the server.
Parameters
- url: string | URL
  The server URL to connect to.
- eventName: string = "message"
- ...otherEvents: string[]
Returns Promise<void>
Implementation of MessageClient.connect
- Defined in src/infrastructure/sse_client.ts:44

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference
Parameters
- event: Event
Returns boolean
Implementation of MessageClient.dispatchEvent
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14386

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
Implementation of MessageClient.removeEventListener
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14392

send

send(_message: string, _type?: string): Promise<void>
Send a message to the server.

This is an optional method for streams with bidirectional communication.
Parameters
- _message: string
- Optional_type: string
Returns Promise<void>
Implementation of MessageClient.send
- Defined in src/infrastructure/sse_client.ts:78

simulateError

simulateError(): void
Simulate an error event.

Returns void
- Defined in src/infrastructure/sse_client.ts:122

simulateMessage

simulateMessage(
    message: string | number | boolean | object | null,
    eventName?: string,
    lastEventId?: string,
): void
Simulate a message event from the server.
Parameters
- message: string | number | boolean | object | null
  The message to receive.
- eventName: string = "message"
  The optional event type.
- OptionallastEventId: string
  The optional last event ID.
Returns void
- Defined in src/infrastructure/sse_client.ts:105

`Static`create

create(): SseClient
Create an SSE client.

Returns SseClient
A new SSE client.
- Defined in src/infrastructure/sse_client.ts:14

`Static`createNull

createNull(): SseClient
Create a nulled SSE client.

Returns SseClient
A new SSE client.
- Defined in src/infrastructure/sse_client.ts:23