This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.



Sets the default options that will be passed in all requests across all @esri/arcgis-rest-js modules.

import { setDefaultRequestOptions } from "@esri/arcgis-rest-request";
  authentication: userSession // all requests will use this session by default

You should never set a default authentication when you are in a server side environment where you may be handling requests for many different authenticated users.

  • setDefaultRequestOptions(options: IRequestOptions, hideWarnings: boolean) : void


Parameter Type Default Notes
options Required IRequestOptions

The default options to pass with every request. Existing default will be overwritten.

hideWarnings Optional boolean

Silence warnings about setting default authentication in shared environments.



Function defined in packages/arcgis-rest-request/src/request.ts:37