Interface TemporalError

Error/status envelope shared by every temporal surface.

interface TemporalError {
    code: TemporalErrorCode;
    details?: unknown;
    job?: TemporalJobRef;
    maskedFields?: readonly string[];
    message: string;
    requiredApprovals?: readonly string[];
    retentionExpiresAt?: string;
}

Properties

code details? job? maskedFields? message requiredApprovals? retentionExpiresAt?

Properties

code

code: TemporalErrorCode

Optionaldetails

details?: unknown

Optionaljob

job?: TemporalJobRef

Job reference to follow when code is large-diff-job-required.

OptionalmaskedFields

maskedFields?: readonly string[]

Fields the server masked from the response when code is masked-fields.

message

message: string

OptionalrequiredApprovals

requiredApprovals?: readonly string[]

Approver roles/identities required when code is approval-required.

OptionalretentionExpiresAt

retentionExpiresAt?: string

Optional retention boundary the request fell outside of.

Settings

Member Visibility

On This Page

Properties