Beignet API reference
    Preparing search index...

    Interface ProviderInstrumentationEventExpectation

    Expected fields for a provider instrumentation event assertion.

    interface ProviderInstrumentationEventExpectation {
        action?: "start" | "setup" | "stop";
        contractName?: string;
        cron?: string;
        details?: unknown;
        durationMs?: number;
        error?: string;
        eventName?: string;
        id?: string;
        jobName?: string;
        kind?: "command" | "query";
        label?: string;
        message?: string;
        messageId?: string;
        messageKind?: "job" | "event";
        messageName?: string;
        method?: string;
        name?: string;
        parentSpanId?: string;
        path?: string;
        phase?: "error" | "start" | "end";
        providerName?: string;
        requestId?: string;
        scheduleName?: string;
        spanId?: string;
        stack?: string;
        status?: unknown;
        summary?: string;
        timestamp?: string;
        timezone?: string;
        traceId?: string;
        traceparent?: string;
        type?:
            | "request"
            | "error"
            | "provider"
            | "job"
            | "schedule"
            | "outbox"
            | "usecase"
            | "eventBus"
            | "custom";
        useCaseName?: string;
        watcher?: string;
    }
    Index
    action? contractName? cron? details? durationMs? error? eventName? id? jobName? kind? label? message? messageId? messageKind? messageName? method? name? parentSpanId? path? phase? providerName? requestId? scheduleName? spanId? stack? status? summary? timestamp? timezone? traceId? traceparent? type? useCaseName? watcher?
    action?: "start" | "setup" | "stop"

    Expected provider lifecycle action.

    contractName?: string

    Expected contract name.

    cron?: string

    Expected schedule cron expression.

    details?: unknown

    Expected structured details. Object values are matched as partial objects.

    durationMs?: number

    Expected duration in milliseconds.

    error?: string

    Expected error summary.

    eventName?: string

    Expected event bus event name.

    id?: string

    Expected event ID.

    jobName?: string

    Expected job name.

    kind?: "command" | "query"

    Expected use-case kind.

    label?: string

    Expected custom event label.

    message?: string

    Expected error message.

    messageId?: string

    Expected outbox message ID.

    messageKind?: "job" | "event"

    Expected outbox message kind.

    messageName?: string

    Expected outbox message name.

    method?: string

    Expected request method.

    name?: string

    Expected use-case or custom event name.

    parentSpanId?: string

    Expected parent span ID.

    path?: string

    Expected request path.

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

    Expected use-case phase.

    providerName?: string

    Expected provider name. Matches providerName on provider lifecycle events and details.providerName on provider instrumentation events.

    requestId?: string

    Expected request correlation ID.

    scheduleName?: string

    Expected schedule name.

    spanId?: string

    Expected span ID.

    stack?: string

    Expected stack trace.

    status?: unknown

    Expected status. This matches request status codes as well as job, outbox, and schedule status strings.

    summary?: string

    Expected human-readable summary.

    timestamp?: string

    Expected ISO timestamp.

    timezone?: string

    Expected schedule time zone.

    traceId?: string

    Expected trace ID.

    traceparent?: string

    Expected traceparent header value.

    type?:
        | "request"
        | "error"
        | "provider"
        | "job"
        | "schedule"
        | "outbox"
        | "usecase"
        | "eventBus"
        | "custom"

    Expected instrumentation event type.

    useCaseName?: string

    Expected use-case name on error events.

    watcher?: string

    Expected watcher name.

    Settings
    Member Visibility

    On This Page
    Properties