AngularTS
    Preparing search index...

    Interface RequestConfig

    Full request configuration accepted by $http(...). See http://docs.angularjs.org/api/ng/service/$http#usage

    interface RequestConfig {
        cache?: boolean | HttpCacheLike;
        data?: unknown;
        eventHandlers?: Partial<Record<string, EventListenerOrEventListenerObject>>;
        headers?: HttpRequestConfigHeaders;
        method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
        params?: HttpParams;
        paramSerializer?: string | ((obj: HttpParams) => string);
        responseType?: string;
        timeout?: number | Promise<unknown>;
        transformRequest?: HttpRequestTransformer | HttpRequestTransformer[];
        transformResponse?: HttpResponseTransformer | HttpResponseTransformer[];
        uploadEventHandlers?: Partial<
            Record<string, EventListenerOrEventListenerObject>,
        >;
        url: string;
        withCredentials?: boolean;
        xsrfCookieName?: string;
        xsrfHeaderName?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cache? data? eventHandlers? headers? method params? paramSerializer? responseType? timeout? transformRequest? transformResponse? uploadEventHandlers? url withCredentials? xsrfCookieName? xsrfHeaderName?

    Properties
    cache?: boolean | HttpCacheLike

    Cache used for cacheable requests. true enables the default cache.

    data?: unknown

    Request body. Shorthand methods with explicit data set this automatically.

    eventHandlers?: Partial<Record<string, EventListenerOrEventListenerObject>>

    Event handlers notified by the underlying transport.

    headers?: HttpRequestConfigHeaders

    Default headers merged into each request.

    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"

    HTTP verb to use for the request.

    params?: HttpParams

    Query parameters appended to the request URL.

    paramSerializer?: string | ((obj: HttpParams) => string)

    Query parameter serializer token or function.

    responseType?: string

    Native fetch response body reader hint.

    timeout?: number | Promise<unknown>

    Millisecond timeout, or a promise whose resolution aborts the request.

    transformRequest?: HttpRequestTransformer | HttpRequestTransformer[]

    Request body transform pipeline.

    transformResponse?: HttpResponseTransformer | HttpResponseTransformer[]

    Response body transform pipeline.

    uploadEventHandlers?: Partial<
        Record<string, EventListenerOrEventListenerObject>,
    >

    Upload event handlers. Not used by the fetch transport.

    url: string

    Request URL. Query parameters from params are appended to this URL.

    withCredentials?: boolean

    Whether cross-site requests should include credentials by default.

    xsrfCookieName?: string

    Cookie name used when reading the XSRF token.

    xsrfHeaderName?: string

    Header name used when sending the XSRF token.

    Settings
    Member Visibility

    On This Page
    Properties