Type Alias StreamError

StreamError: {
    code: number;
    error?: Record<string, unknown>;
    is_stream_error?: boolean;
    job_id?: string;
    message: string;
    name?: string;
    stack?: string;
}

Describes the structure of a stream error

Type declaration

  • code: number

    Numeric code corresponding to the type of error

  • Optionalerror?: Record<string, unknown>

    Custom user-defined error details

  • Optionalis_stream_error?: boolean

    True if originating via a standard transition message with an error status

  • Optionaljob_id?: string

    Optional job identifier, used when communicating errors externally

  • message: string

    Descriptive message of the error

  • Optionalname?: string

    Name of the error if unhandled

  • Optionalstack?: string

    Stack trace of the error if unhandled

Settings

Member Visibility