@esri/arcgis-rest-request/dist/esm/utils/IRequestOptions.d.ts

Common methods and utilities for @esri/arcgis-rest-js packages.

import { HTTPMethods } from "./HTTPMethods.js";
import { IParams } from "./IParams.js";
import { IAuthenticationManager } from "./IAuthenticationManager.js";
/**
 * Options for the `request()` method.
 */
export interface IRequestOptions {
    /**
     * Additional parameters to pass in the request.
     */
    params?: IParams;
    /**
     * The HTTP method to send the request with.
     */
    httpMethod?: HTTPMethods;
    /**
     * Return the raw [response](https://developer.mozilla.org/en-US/docs/Web/API/Response)
     */
    rawResponse?: boolean;
    /**
     * The instance of {@linkcode ArcGISIdentityManager}, {@linkcode ApplicationCredentialsManager} or {@linkcode APIKeyManager} to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.
     */
    authentication?: IAuthenticationManager | string;
    /**
     * Prevents the token from being passed in a URL Query param that is saved in browser history.
     * Instead, the token will be passed in POST request body or through X-Esri-Authorization header.
     * NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
     */
    hideToken?: boolean;
    /**
     * Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication
     * exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
     */
    portal?: string;
    /**
     * The implementation of `fetch` to use. Defaults to a global `fetch`.
     */
    /**
     * A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
     */
    credentials?: RequestCredentials;
    /**
     * If the length of a GET request's URL exceeds `maxUrlLength` the request will use POST instead.
     */
    maxUrlLength?: number;
    /**
     * Additional [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers) to pass into the request.
     */
    headers?: {
        [key: string]: any;
    };
    /**
     * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) object instance; allows you to abort a request and via an [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
     */
    signal?: AbortSignal;
    /**
     * Suppress any ArcGIS REST JS related warnings for this request.
     */
    suppressWarnings?: boolean;
    /**
     * Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
     * @param requestOptions
     * @returns
     */
    request?: (url: string, requestOptions: InternalRequestOptions) => Promise<any>;
}
/**
 * Options for the function that will be making the actual request.
 */
export declare type InternalRequestOptions = Omit<IRequestOptions, "request">;