Options for the request() method.
authentication string | IAuthenticationManager
The instance of ArcGISIdentityManager, ApplicationCredentialsManager or 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.
credentials RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headers { [key: string]:Â any }
Additional Headers to pass into the request.
hideToken boolean
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.
httpMethod HTTPMethods
The HTTP method to send the request with.
maxUrlLength number
If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params IParams
Additional parameters to pass in the request.
portal string
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'.
rawResponse boolean
Return the raw response
signal AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings boolean
Suppress any ArcGIS REST JS related warnings for this request.
authenticationoptional
Interface Property credentialsoptional
Interface Propertycredentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headersoptional
Interface Propertyheaders: { [key: string]:Â any }
Additional Headers to pass into the request.
Type declarationoptional
Interface PropertyhideToken: boolean
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.
httpMethodoptional
Interface PropertyhttpMethod: HTTPMethods
The HTTP method to send the request with.
maxUrlLengthoptional
Interface PropertymaxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
optional
Interface Propertyparams: IParams
Additional parameters to pass in the request.
portaloptional
Interface Propertyportal: string
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'.
rawResponseoptional
Interface PropertyrawResponse: boolean
Return the raw response
signaloptional
Interface Property suppressWarningsoptional
Interface PropertysuppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
Methods Method Returns Notes request(url,ârequestOptions) Promise<any>
Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
requestoptional
Interface Methodrequest(url:Â string,ârequestOptions:Â InternalRequestOptions): Promise<any>
Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
ReturnsÂPromise<any>
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4