Beignet API reference
    Preparing search index...

    Interface UseCaseEvent

    Logged when a use case runs.

    interface UseCaseEvent {
        details?: unknown;
        durationMs?: number;
        error?: string;
        id: string;
        kind?: "command" | "query";
        name: string;
        parentSpanId?: string;
        phase: "error" | "start" | "end";
        requestId?: string;
        spanId?: string;
        timestamp: string;
        traceId?: string;
        traceparent?: string;
        type: "usecase";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    details? durationMs? error? id kind? name parentSpanId? phase requestId? spanId? timestamp traceId? traceparent? type watcher?

    Properties

    details?: unknown

    Optional structured detail payload. Devtools applies default redaction to this field before events are stored.

    durationMs?: number
    error?: string
    id: string

    Unique identifier for this event (UUID or timestamp-based).

    kind?: "command" | "query"
    name: string
    parentSpanId?: string

    Parent span ID when this event belongs to a nested operation.

    phase: "error" | "start" | "end"
    requestId?: string

    Optional correlation ID to link events from the same request/operation.

    spanId?: string

    Span ID for the operation represented by this event.

    timestamp: string

    ISO timestamp when the event occurred.

    traceId?: string

    W3C trace ID for cross-service correlation.

    traceparent?: string

    W3C traceparent header value associated with this event.

    type: "usecase"
    watcher?: string

    Optional watcher name that owns this event. Built-in events can infer their watcher from type; custom integrations can set this to use their own watcher configuration.

    Settings

    Member Visibility

    On This Page

    Properties