setDefaultRequestOptions

setDefaultRequestOptions

setDefaultRequestOptions(optionsIRequestOptions, hideWarnings?boolean): void

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

Use dark colors for code blocksCopy
     
1
2
3
4
5
import { setDefaultRequestOptions } from "@esri/arcgis-rest-request";

setDefaultRequestOptions({
  authentication: ArcGISIdentityManager // 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.

Parameters
ParameterTypeNotes
options
IRequestOptions

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

hideWarnings
boolean

Silence warnings about setting default authentication in shared environments.

Returns 
void

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.