Back to Pocketbase

Class SubscriptionMessage

static/jsvm/classes/SubscriptionMessage.html

latest1.9 KB
Original Source

Class SubscriptionMessage

SubscriptionMessage defines a realtime subscription payload.

Example:

onRealtimeConnectRequest((e) => { e.client.send(new SubscriptionMessage({ name: "example", data: '{"greeting": "Hello world"}' }))})Copy

Hierarchy

Implements

Index

Constructors

constructor

Methods

writeSSE

Properties

dataname

Constructors

constructor

Parameters

Optional options: Partial<subscriptions.Message>

Returns SubscriptionMessage

Methods

writeSSE

  • writeSSE(w, eventId): void

WriteSSE writes the current message in a SSE format into the provided writer.

For example, writing to a router.Event:

m := Message{Name: "users/create", Data: []byte{...}} m.WriteSSE(e.Response, "yourEventId") e.Flush()Copy

Parameters

w: io.Writer
eventId: string

Returns void

Properties

data

data: string | number[]

name

name: string

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

On This Page

Generated using TypeDoc