Interface EventBusLike

Event bus shape required by Beignet listener registration helpers.

interface EventBusLike {
    publish<E extends EventPayloadDef<string, StandardSchema>>(
        event: E,
        payload: InferEventPayload<E>,
    ): MaybePromise<void>;
    subscribe<E extends EventPayloadDef<string, StandardSchema>>(
        event: E,
        handler: (payload: InferEventPayload<E>) => MaybePromise<void>,
    ): () => void;
}

Index

Methods

publish subscribe

Methods

publish

publish<E extends EventPayloadDef<string, StandardSchema>>(
event: E,
payload: InferEventPayload<E>,
): MaybePromise<void>
Publish an event payload.
Type Parameters
- E extends EventPayloadDef<string, StandardSchema>
Parameters
- event: E
- payload: InferEventPayload<E>
Returns MaybePromise<void>
- Defined in packages/core/src/events/index.ts:142

subscribe<E extends EventPayloadDef<string, StandardSchema>>(
event: E,
handler: (payload: InferEventPayload<E>) => MaybePromise<void>,
): () => void
Subscribe to an event and return an unsubscribe function.
Type Parameters
- E extends EventPayloadDef<string, StandardSchema>
Parameters
- event: E
- handler: (payload: InferEventPayload<E>) => MaybePromise<void>
Returns () => void
- Defined in packages/core/src/events/index.ts:149