Methods (4)

▶ listEvents() You can provide a client instance returned by `createClient()` instead of API ref →
platform-events.listEvents({
  query: { q?: string, sort?: string, type?: string, source?: string, subject?: string, traceid?: string, causationid?: string, start?: string, end?: string, limit?: number, offset?: number },
})
Parameters
q search → string query optional
sort string query optional
type string query optional
source string query optional
subject string query optional
traceid string query optional
causationid string query optional
start string query optional
end string query optional
limit number query optional
offset number query optional
▶ publishEvent() Publish an event API ref →
platform-events.publishEvent({ body: { ... } })
Parameters
body object body required
▶ streamEvents() Stream domain events (SSE) API ref →
platform-events.streamEvents({
  query: { type?: string, source?: string, subject?: string },
})
Parameters
type string query optional
source string query optional
subject string query optional
▶ getEvent(eventId) Get a domain event API ref →
platform-events.getEvent({ path: { eventId: string } })
Parameters
eventId string path required

Types (2)

▶ Event 2 fields
interface Event {
type: string
description?: string
}
▶ EventList 4 fields
interface EventList {
total: number
limit: number
offset: number
hasNext?: boolean
}