Sanity Library Reference Docs
    Preparing search index...

    Interface RequestErrorReportOptionsBeta

    Options for delegating a request error to the studio's error UI.

    interface RequestErrorReportOptions {
        retryable?: boolean;
    }
    Index

    Properties

    Properties

    retryable?: boolean

    Whether the failed request is safe to re-run. Only set this to true when re-running cannot cause harm: the request is idempotent (reads), or it is guaranteed to have been rejected before processing (429s).

    When true, the studio's error dialog offers a "Try again" button that re-runs the request. When false (the default), the dialog only offers "Reload Studio" and uses more conservative copy, warning that the last change may or may not have been applied.

    Note: retry requires a re-runnable request, so it only takes effect with attempt() (which has the thunk to re-invoke). The handle rejection-handler form cannot re-run the request.