Beignet API reference
    Preparing search index...

    Options for the in-memory event bus provider.

    interface InMemoryEventBusProviderOptions {
        delivery?: InMemoryEventBusDelivery;
        name?: string;
        onHandlerError?: (
            error: unknown,
            eventName: string,
            payload: unknown,
        ) => void;
    }

    Hierarchy

    Index

    Properties

    How publish calls deliver events to subscribed handlers.

    Defaults to "await-handlers" so local development and tests observe handler work deterministically. Use "fire-and-forget" for detached in-process delivery when the caller should not wait for listeners.

    name?: string

    Provider name. Defaults to "event-bus-memory".

    onHandlerError?: (error: unknown, eventName: string, payload: unknown) => void

    Called when an async event handler throws an error.

    In "await-handlers" mode, handler errors are rethrown when this callback is not provided. In "fire-and-forget" mode, handler errors are swallowed when this callback is not provided so detached handlers do not create unhandled rejections.

    Type Declaration

      • (error: unknown, eventName: string, payload: unknown): void
      • Parameters

        • error: unknown

          The error thrown by the handler

        • eventName: string

          The name of the event being handled

        • payload: unknown

          The event payload that was passed to the handler

        Returns void