SseMessage

One event to send.

One event to send. A string is the data of an unnamed event.

Import#

import type { SseMessage } from "@shadow-js/dusk/server";

Signature#

interface SseMessage {
  /** The payload. A string is sent as is; anything else as JSON. Omitted: no data line. */
  readonly data?: unknown;
  /** The event name (the browser's `addEventListener` name). Default: `message`. */
  readonly event?: string;
  /** The event id, sent back as `Last-Event-ID` after a reconnect. */
  readonly id?: string;
  /** Reconnect delay the browser uses, in milliseconds. */
  readonly retry?: number;
}

Members#

Name	Type	Description
`data?`	`readonly data?: unknown`	The payload. A string is sent as is; anything else as JSON. Omitted: no data line.
`event?`	`readonly event?: string`	The event name (the browser's `addEventListener` name). Default: `message`.
`id?`	`readonly id?: string`	The event id, sent back as `Last-Event-ID` after a reconnect.
`retry?`	`readonly retry?: number`	Reconnect delay the browser uses, in milliseconds.