Interface IRequestConfig

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

Hierarchy

Index

Properties

Properties

optional public 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.

optional public data?: any

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

optional public headers?: any

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.

public method: string

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

optional public params?: any

{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.

optional public responseType?: string

See requestType.

optional public timeout?: any

{number|Promise} Timeout in milliseconds, or promise that should abort the request when resolved.

optional public transformRequest?: any

{function(data, headersGetter)|Array.} 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.

optional public transformResponse?: any

{function(data, headersGetter)|Array.} 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.

public url: string

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

optional public 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.

optional public xsrfCookieName?: string

Name of cookie containing the XSRF token.

optional public xsrfHeaderName?: string

Name of HTTP header to populate with the XSRF token.