@b-jones-rfd/sp-rest-connect - v5.1.1
    Preparing search index...

    Type Alias Failure

    Failed action result.

    error is a human-readable message prefixed with the action name, for logging. code classifies the failure; status and details are present for HTTP/AUTH failures when SharePoint supplied them.

    type Failure = {
        code: FailureCode;
        details?: SharePointError;
        error: string;
        retryAfterMs?: number;
        status?: number;
        success: false;
    }
    Index
    details?: SharePointError

    Parsed SharePoint error body, when the response carried one.

    error: string
    retryAfterMs?: number

    How long the server asked clients to wait before retrying, from a Retry-After header (429/503). The retry logic honours it.

    status?: number

    HTTP status code, for HTTP and AUTH failures.

    success: false