Type alias RequestParameters

RequestParameters: {
    body?: string;
    cache?: RequestCache;
    collectResourceTiming?: boolean;
    credentials?: "same-origin" | "include";
    headers?: any;
    method?: "GET" | "POST" | "PUT";
    type?: "string" | "json" | "arrayBuffer" | "image";
    url: string;
}

A RequestParameters object to be returned from Map.options.transformRequest callbacks.

Type declaration

  • Optional body?: string

    Request body.

  • Optional cache?: RequestCache

    Parameters supported only by browser fetch API. Property of the Request interface contains the cache mode of the request. It controls how the request will interact with the browser's HTTP cache. (https://developer.mozilla.org/en-US/docs/Web/API/Request/cache)

  • Optional collectResourceTiming?: boolean

    If true, Resource Timing API information will be collected for these transformed requests and returned in a resourceTiming property of relevant data events.

  • Optional credentials?: "same-origin" | "include"

    'same-origin'|'include' Use 'include' to send cookies with cross-origin requests.

  • Optional headers?: any

    The headers to be sent with the request.

  • Optional method?: "GET" | "POST" | "PUT"

    Request method 'GET' | 'POST' | 'PUT'.

  • Optional type?: "string" | "json" | "arrayBuffer" | "image"

    Response body type to be returned.

  • url: string

    The URL to be requested.

Example

// use transformRequest to modify requests that begin with `http://myHost`
transformRequest: function(url, resourceType) {
 if (resourceType === 'Source' && url.indexOf('http://myHost') > -1) {
   return {
     url: url.replace('http', 'https'),
     headers: { 'my-custom-header': true },
     credentials: 'include'  // Include cookies for cross-origin requests
   }
  }
}

Settings

Member Visibility

Theme