EventsAPI
Defined in: namespaces.ts:572
Host events (legacy pair) + the fn-70 typed event bus.
The legacy subscribe/unsubscribe pair is a PERMANENT alias (ADR-001)
— it is not deprecated, but new inter-plugin messaging should use the
typed-bus methods, which add schema validation, retention, and delivery
modes. Typed-bus scopes: events.topic.declare, events.emit,
events.subscribe, events.replay, events.inspect, plus contributor
scopes events.serializer.register / events.sink.register.
Methods
Section titled “Methods”subscribe()
Section titled “subscribe()”subscribe(
eventName,handler):string
Defined in: namespaces.ts:574
Subscribes to a host event. Returns subscription token.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(payload) => void
Returns
Section titled “Returns”string
unsubscribe()
Section titled “unsubscribe()”unsubscribe(
token):void
Defined in: namespaces.ts:576
Cancels a host event subscription.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
declareTopic()
Section titled “declareTopic()”declareTopic(
spec):Promise<void>
Defined in: namespaces.ts:580
Declares a schema-registered topic. [events.topic.declare]
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
emitTopic()
Section titled “emitTopic()”emitTopic(
name,payload,metadata?):Promise<void>
Defined in: namespaces.ts:582
Emits a payload to a declared topic. [events.emit]
Parameters
Section titled “Parameters”string
payload
Section titled “payload”unknown
metadata?
Section titled “metadata?”Record<string, unknown>
Returns
Section titled “Returns”Promise<void>
subscribeTopic()
Section titled “subscribeTopic()”subscribeTopic(
name,handler):Promise<string>
Defined in: namespaces.ts:584
Subscribes to a topic. Resolves to a subscription token. [events.subscribe]
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(envelope) => void
Returns
Section titled “Returns”Promise<string>
replay()
Section titled “replay()”replay(
name,opts?):Promise<EventEnvelope[]>
Defined in: namespaces.ts:586
Replays retained events for a topic. [events.replay]
Parameters
Section titled “Parameters”string
limit?
Section titled “limit?”number
since?
Section titled “since?”string
Returns
Section titled “Returns”Promise<EventEnvelope[]>
listTopics()
Section titled “listTopics()”listTopics():
Promise<TopicInfo[]>
Defined in: namespaces.ts:588
Lists visible declared topics. [events.inspect]
Returns
Section titled “Returns”Promise<TopicInfo[]>