Sanity Library Reference Docs
    Preparing search index...

    Interface RequestOptions

    interface RequestOptions {
        url: string;
        body?: any;
        bodySize?: number;
        cancelToken?: any;
        compress?: boolean;
        headers?: any;
        maxRedirects?: number;
        maxRetries?: number;
        retryDelay?: (attemptNumber: number) => number;
        method?: string;
        proxy?: string | false | ProxyOptions | null;
        query?: any;
        rawBody?: boolean;
        shouldRetry?: any;
        stream?: boolean;
        timeout?: any;
        tunnel?: boolean;
        debug?: any;
        requestId?: number;
        attemptNumber?: number;
        withCredentials?: boolean;
        fetch?: boolean | Omit<RequestInit, "method">;
        useAbortSignal?: boolean;
    }
    Index

    Properties

    url body? bodySize? cancelToken? compress? headers? maxRedirects? maxRetries? retryDelay? method? proxy? query? rawBody? shouldRetry? stream? timeout? tunnel? debug? requestId? attemptNumber? withCredentials? fetch? useAbortSignal?

    Properties

    url: string

    Optionalbody

    body?: any
    bodySize?: number
    cancelToken?: any
    compress?: boolean
    headers?: any
    maxRedirects?: number
    maxRetries?: number
    retryDelay?: (attemptNumber: number) => number
    method?: string
    proxy?: string | false | ProxyOptions | null
    query?: any
    rawBody?: boolean
    shouldRetry?: any
    stream?: boolean
    timeout?: any
    tunnel?: boolean
    debug?: any
    requestId?: number
    attemptNumber?: number
    withCredentials?: boolean
    fetch?: boolean | Omit<RequestInit, "method">

    Enables using the native fetch API instead of the default http module, and allows setting its options like cache

    useAbortSignal?: boolean

    Some frameworks have special behavior for fetch when an AbortSignal is used, and may want to disable it unless userland specifically opts-in.

    Settings

    Member Visibility

    On This Page

    Properties