AngularTS
    Preparing search index...

    Interface RequestConfig

    Object describing the request to be made and how it should be processed. see http://docs.angularjs.org/api/ng/service/$http#usage

    interface RequestConfig {
        cache?: any;
        data?: any;
        eventHandlers?: { [type: string]: EventListenerOrEventListenerObject };
        headers?: HttpRequestConfigHeaders;
        method: string;
        params?: any;
        paramSerializer?: string | ((obj: any) => string);
        responseType?: string;
        timeout?: number | Promise<any>;
        transformRequest?: HttpRequestTransformer | HttpRequestTransformer[];
        transformResponse?: HttpResponseTransformer | HttpResponseTransformer[];
        uploadEventHandlers?: {
            [type: string]: EventListenerOrEventListenerObject;
        };
        url: string;
        withCredentials?: boolean;
        xsrfCookieName?: string;
        xsrfHeaderName?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cache?: any

    {boolean|Cache} If true, a default $http cache will be used to cache the GET request, otherwise if a cache instance built with $cacheFactory, this cache will be used for caching.

    data?: any

    {string|Object} Data to be sent as the request message data.

    eventHandlers?: { [type: string]: EventListenerOrEventListenerObject }

    Event listeners to be bound to the XMLHttpRequest object. To bind events to the XMLHttpRequest upload object, use uploadEventHandlers. The handler will be called in the context of a $apply block.

    Map of strings or functions which return strings representing HTTP headers to send to the server. If the return value of a function is null, the header will not be sent. The key of the map is the request verb in lower case. The "common" key applies to all requests.

    method: string

    HTTP method (e.g. 'GET', 'POST', etc)

    params?: any

    {Object.<string|Object>} Map of strings or objects which will be turned to ?key1=value1&key2=value2 after the url. If the value is not a string, it will be JSONified.

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

    A function used to the prepare string representation of request parameters (specified as an object). If specified as string, it is interpreted as a function registered with the $injector. Defaults to $httpParamSerializer.

    responseType?: string
    timeout?: number | Promise<any>

    Timeout in milliseconds, or promise that should abort the request when resolved.

    Transform function or an array of such functions. The transform function takes the http request body and headers and returns its transformed (typically serialized) version.

    Transform function or an array of such functions. The transform function takes the http response body and headers and returns its transformed (typically deserialized) version.

    uploadEventHandlers?: { [type: string]: EventListenerOrEventListenerObject }

    Event listeners to be bound to the XMLHttpRequest upload object. To bind events to the XMLHttpRequest object, use eventHandlers. The handler will be called in the context of a $apply block.

    url: string

    Absolute or relative URL of the resource that is being requested.

    withCredentials?: boolean

    whether to to set the withCredentials flag on the XHR object. See [requests with credentials]https://developer.mozilla.org/en/http_access_control#section_5 for more information.

    xsrfCookieName?: string

    Name of cookie containing the XSRF token.

    xsrfHeaderName?: string

    Name of HTTP header to populate with the XSRF token.