urlUtils | API Reference | ArcGIS Maps SDK for JavaScript 4.32

See also

Method Overview

Return Type	Summary	Object
Number	Adds the given proxy rule to the proxy rules list: `esriConfig.request.proxyRules`.	urlUtils
Object\|null\|undefined	Returns the proxy rule that matches the given URL.	urlUtils
Boolean	Tests whether a url uses the data protocol.	urlUtils
Boolean	Tests whether a url uses the https protocol.	urlUtils
Object\|null\|undefined	Converts the URL arguments to an object representation.	urlUtils

Method Details

addProxyRule Method addProxyRule(rule){Number}static

Adds the given proxy rule to the proxy rules list: esriConfig.request.proxyRules.

Parameters

Specification

rule Object

An object specifying a URL that should use the proxy. See the object specification table below for the required properties of this object.

Specification

proxyUrl String

The URL of the proxy.

urlPrefix String

The URL prefix of the resources that should be accessed through the given proxy.

Returns

Type	Description
Number	The index of the proxy rule in the `esriConfig.request.proxyRules` array.

See also

esriConfig.request

getProxyRule Method getProxyRule(url){Object |null |undefined}static

Returns the proxy rule that matches the given URL.

Parameter

url String

The URL of the resources accessed via proxy.

Returns

Type	Description
Object \| null \| undefined	The proxy rule object as defined in `esriConfig.request.proxyRules`.

See also

esriConfig.request

isDataProtocol Method isDataProtocol(url){Boolean}static Since: ArcGIS Maps SDK for JavaScript 4.32 urlUtils since 4.0, isDataProtocol added at 4.32.

Tests whether a url uses the data protocol.

This will return true if the url starts with data:.

Parameter

url String

The url to test.

Returns

Type	Description
Boolean	Returns `true` if the url uses the data protocol, false otherwise.

isHTTPSProtocol Method isHTTPSProtocol(url){Boolean}static Since: ArcGIS Maps SDK for JavaScript 4.32 urlUtils since 4.0, isHTTPSProtocol added at 4.32.

Tests whether a url uses the https protocol.

This will return true if the url starts with the https protocol, or if the url is protocol relative and the application is running on https.

Parameter

url String

The url to test.

Returns

Type	Description
Boolean	Returns `true` if the url uses the https protocol, false otherwise.

urlToObject Method urlToObject(url){Object |null |undefined}static

Converts the URL arguments to an object representation.

Parameter

url String|null|undefined

The input URL.

Returns

Type

Description

Object | null | undefined

Returns an object representing the URL, its parameters, and parameter values. The specification of the object is the following:

Property	Type	Description
path	String	The path of the given URL.
query	Object	An object whose properties and values are the parameters and parameter values of the given URL.

Example

let myObject = urlUtils.urlToObject("http://www.myworld.com?state_name=Ohio&city_name=Akron");
  // The value of my Object is...
  // { path: "http://www.myworld.com", query: {state_name: "Ohio", city_name: "Akron"} }