Interface JRequestConfig

interface JRequestConfig {
    accessToken?: string;
    headers?: {
        [key: string]: any;
    };
    ignoreJMapAuthorizationHeaderParam?: boolean;
    includeHeadersInResponse?: boolean;
    params?: string | {
        [key: string]: any;
    };
    responseType?: "stream" | "text" | "arraybuffer" | "blob" | "document" | "json";
    url: string;
}

Properties

accessToken? headers? ignoreJMapAuthorizationHeaderParam? includeHeadersInResponse? params? responseType? url

Properties

Optional accessToken

accessToken?: string

For request on JMap servers only.

Optional headers

headers?: {
    [key: string]: any;
}

To specify custom headers (Authorization, Content-type, etc) that you might want to use for external ressources.

Type declaration

  • [key: string]: any

Optional ignoreJMapAuthorizationHeaderParam

ignoreJMapAuthorizationHeaderParam?: boolean

If true will ignore the JMap authorization headers.

Optional includeHeadersInResponse

includeHeadersInResponse?: boolean

If true will return the header in the response.

Optional params

params?: string | {
    [key: string]: any;
}

Body params, that will be passed in the request.

Type declaration

  • [key: string]: any

Optional responseType

responseType?: "stream" | "text" | "arraybuffer" | "blob" | "document" | "json"

Allow callers to request raw data (blob, arraybuffer, etc).

url

url: string

The url to request.

Settings

Member Visibility

Theme

On This Page

accessTokenheadersignoreJMapAuthorizationHeaderParamincludeHeadersInResponseparamsresponseTypeurl