Circle V2 API Docs
    Preparing search index...

    Type Alias DefineStepOptions<TArgs, TReturn>

    type DefineStepOptions<TArgs extends unknown[], TReturn = unknown> = {
        metadata?: Record<string, unknown>;
        processOutputs?: (output: TReturn) => Record<string, unknown>;
        runType?: WithStepTraceOptions["runType"];
        traceInputs?: (...args: TArgs) => Record<string, unknown>;
    }

    Type Parameters

    • TArgs extends unknown[]
    • TReturn = unknown
    Index

    Properties

    metadata? processOutputs? runType? traceInputs?

    Properties

    metadata?: Record<string, unknown>

    Extra non-PII metadata for the span.

    processOutputs?: (output: TReturn) => Record<string, unknown>

    Projection of the return value to record instead of the value itself.

    runType?: WithStepTraceOptions["runType"]

    Span run type. Deterministic steps are chains (the default).

    traceInputs?: (...args: TArgs) => Record<string, unknown>

    Optional non-PII projection of the arguments to record as the span's inputs. Defaults to no inputs — the return value (auto-captured) is usually the debug signal, and raw args (message histories, document maps) are large and low-signal even though the BAA permits them.

    Settings

    Member Visibility

    On This Page

    Properties