Beignet API reference
    Preparing search index...

    Interface DevtoolsPort

    Port interface for devtools.

    Apps and server internals can log framework events here during development. The events are stored in an in-memory buffer and can be retrieved via HTTP handlers.

    interface DevtoolsPort {
        clear(): void | Promise<void>;
        getEvents(filter?: DevtoolsFilter): DevtoolsEvent[];
        getWatchers(): DevtoolsWatcher[];
        isWatcherEnabled(name: DevtoolsWatcherName): boolean;
        log(event: DevtoolsEvent): void;
        record(
            event:
                | Omit<RequestEvent, "id" | "timestamp"> & Partial<
                    Pick<RequestEvent, "id" | "timestamp">,
                >
                | Omit<ErrorEvent, "id" | "timestamp"> & Partial<
                    Pick<ErrorEvent, "id" | "timestamp">,
                >
                | Omit<UseCaseEvent, "id" | "timestamp"> & Partial<
                    Pick<UseCaseEvent, "id" | "timestamp">,
                >
                | Omit<EventBusEvent, "id" | "timestamp"> & Partial<
                    Pick<EventBusEvent, "id" | "timestamp">,
                >
                | Omit<JobEvent, "id" | "timestamp"> & Partial<
                    Pick<JobEvent, "id" | "timestamp">,
                >
                | Omit<ScheduleEvent, "id" | "timestamp"> & Partial<
                    Pick<ScheduleEvent, "id" | "timestamp">,
                >
                | Omit<ProviderEvent, "id" | "timestamp"> & Partial<
                    Pick<ProviderEvent, "id" | "timestamp">,
                >
                | Omit<CustomDevtoolsEvent, "id" | "timestamp"> & Partial<
                    Pick<CustomDevtoolsEvent, "id" | "timestamp">,
                >,
        ): DevtoolsEvent;
        subscribe(listener: DevtoolsListener): () => void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    clear getEvents getWatchers isWatcherEnabled log record subscribe

    Methods

    • Clear all buffered events (dev-only).

      Returns void | Promise<void>

    • Return the watcher configuration installed for this devtools instance.

      Returns DevtoolsWatcher[]

    • Log a devtools event into the in-memory buffer.

      Parameters

      Returns void

    • Record an event and fill common fields such as id and timestamp.

      Parameters

      • event:
            | Omit<RequestEvent, "id" | "timestamp"> & Partial<
                Pick<RequestEvent, "id" | "timestamp">,
            >
            | Omit<ErrorEvent, "id" | "timestamp"> & Partial<
                Pick<ErrorEvent, "id" | "timestamp">,
            >
            | Omit<UseCaseEvent, "id" | "timestamp"> & Partial<
                Pick<UseCaseEvent, "id" | "timestamp">,
            >
            | Omit<EventBusEvent, "id" | "timestamp"> & Partial<
                Pick<EventBusEvent, "id" | "timestamp">,
            >
            | Omit<JobEvent, "id" | "timestamp"> & Partial<
                Pick<JobEvent, "id" | "timestamp">,
            >
            | Omit<ScheduleEvent, "id" | "timestamp"> & Partial<
                Pick<ScheduleEvent, "id" | "timestamp">,
            >
            | Omit<ProviderEvent, "id" | "timestamp"> & Partial<
                Pick<ProviderEvent, "id" | "timestamp">,
            >
            | Omit<CustomDevtoolsEvent, "id" | "timestamp"> & Partial<
                Pick<CustomDevtoolsEvent, "id" | "timestamp">,
            >

        The event payload to record

      Returns DevtoolsEvent

      The normalized event that was stored

    • Subscribe to event buffer changes. Used by the live SSE endpoint.

      Parameters

      • listener: DevtoolsListener

        Called when an event is recorded or the buffer is cleared

      Returns () => void

      Cleanup function that removes the listener

    Settings

    Member Visibility

    On This Page

    Methods