@ohos.url (URL String Parsing)

The url module provides APIs for parsing URL strings and constructing URL instances to process URL strings.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { url } from '@kit.ArkTS';

URLParams⁹⁺

Defines APIs for handling URL query strings.

constructor⁹⁺

constructor(init?: string[][]|Record<string, string>|string|URLParams)

A constructor used to create a URLParams instance.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
init	string[][] |Record<string, string> |string |URLParams	No	Input parameter objects, which include the following: - string[][]: two-dimensional string array. - Record<string, string>: list of objects. - string: string. - URLParams: object. The default value is null.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.

Example

// Construct a URLParams object in string[][] mode.
let objectParams = new url.URLParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
// Construct a URLParams object in Record<string, string> mode.
let objectParams1 = new url.URLParams({"fod" : '1' , "bard" : '2'});
// Construct a URLParams object in string mode.
let objectParams2 = new url.URLParams('?fod=1&bard=2');
// Construct a URLParams object using the search attribute of the url object.
let urlObject = url.URL.parseURL('https://developer.mozilla.org/?fod=1&bard=2');
let objectParams3 = new url.URLParams(urlObject.search);
// Construct a URLParams object using the params attribute of the url object.
let urlObject1 = url.URL.parseURL('https://developer.mozilla.org/?fod=1&bard=2');
let objectParams4 = urlObject1.params;

append⁹⁺

append(name: string, value: string): void

Appends a key-value pair into the query string.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the key-value pair to append.
value	string	Yes	Value of the key-value pair to append.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLParams(urlObject.search.slice(1));
paramsObject.append('fod', '3');

delete⁹⁺

delete(name: string): void

Deletes key-value pairs of the specified key.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the key-value pairs to delete.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLParams(urlObject.search.slice(1));
paramsObject.delete('fod');

getAll⁹⁺

getAll(name: string): string[]

Obtains all the values based on the specified key.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Target key.

Return value

Type	Description
string[]	All the values obtained.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new url.URLParams(urlObject.search.slice(1));
params.append('fod', '3'); // Add a second value for the fod parameter.
console.log(params.getAll('fod').toString()) // Output ["1","3"].

entries⁹⁺

entries(): IterableIterator<[string, string]>

Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and the first and second fields of each array are the key and value respectively.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<[string, string]>	ES6 iterator.

Example

let searchParamsObject = new url.URLParams("keyName1=valueName1&keyName2=valueName2");
let pair:Iterable<Object[]> = searchParamsObject.entries();
let arrayValue = Array.from(pair);
for (let pair of arrayValue) { // Show keyName/valueName pairs
  console.log(pair[0]+ ', '+ pair[1]);
}

forEach⁹⁺

forEach(callbackFn: (value: string, key: string, searchParams: URLParams) => void, thisArg?: Object): void

Traverses the key-value pairs in the URLSearchParams instance by using a callback.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
callbackFn	function	Yes	Callback invoked to traverse the key-value pairs in the URLSearchParams instance.
thisArg	Object	No	Value of this to use when callbackFn is invoked. The default value is this object.

Table 1 callbackFn parameter description

Name	Type	Mandatory	Description
value	string	Yes	Value that is currently traversed.
key	string	Yes	Key that is currently traversed.
searchParams	URLParams	Yes	Instance that invokes the forEach method.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

const myURLObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
myURLObject.params.forEach((value, name, searchParams) => {
    console.log(name, value, myURLObject.params === searchParams);
});

get⁹⁺

get(name: string): string|null

Obtains the value of the first key-value pair based on the specified key.

NOTE

If the key-value pair does not exist, undefined is returned.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key specified to obtain the value.

Return value

Type	Description
string	Returns the value of the first key-value pair if obtained.
null	Returns null if no value is obtained.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let paramsObject = new url.URLParams('name=Jonathan&age=18');
let name = paramsObject.get("name"); // is the string "Jonathan"
let age = paramsObject.get("age"); // is the string "18"
let getObj = paramsObject.get("abc"); // undefined

has⁹⁺

has(name: string): boolean

Checks whether a key has a value.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key specified to search for its value.

Return value

Type	Description
boolean	Returns true if the value exists; returns false otherwise.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLParams(urlObject.search.slice(1));
let result = paramsObject.has('bard');

set⁹⁺

set(name: string, value: string): void

Sets the value for a key. If key-value pairs matching the specified key exist, the value of the first key-value pair will be set to the specified value and other key-value pairs will be deleted. Otherwise, the key-value pair will be appended to the query string.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the value to set.
value	string	Yes	Value to set.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLParams(urlObject.search.slice(1));
paramsObject.set('baz', '3'); // Add a third parameter.

sort⁹⁺

sort(): void

Sorts all key-value pairs contained in this object based on the Unicode code points of the keys and returns undefined. This method uses a stable sorting algorithm, that is, the relative order between key-value pairs with equal keys is retained.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Example

let searchParamsObject = new url.URLParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
searchParamsObject.sort(); // Sort the key/value pairs
console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=4&c=3&d=2

keys⁹⁺

keys(): IterableIterator&lt;string&gt;

Obtains an ES6 iterator that contains the keys of all the key-value pairs.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<string>	ES6 iterator that contains the keys of all the key-value pairs.

Example

let searchParamsObject = new url.URLParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
let keys = Array.from(searchParamsObject.keys());
for (let key of keys) { // Output key-value pairs
  console.log(key);
}

values⁹⁺

values(): IterableIterator&lt;string&gt;

Obtains an ES6 iterator that contains the values of all the key-value pairs.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<string>	ES6 iterator that contains the values of all the key-value pairs.

Example

let searchParams = new url.URLParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
let values = Array.from(searchParams.values());
for (let value of values) {
  console.log(value);
}

[Symbol.iterator]⁹⁺

[Symbol.iterator](): IterableIterator&lt;[string, string]&gt;

Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and the first and second fields of each array are the key and value respectively.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<[string, string]>	ES6 iterator.

Example

const paramsObject = new url.URLParams('fod=bay&edg=bap');
let iter: Iterable<Object[]> = paramsObject[Symbol.iterator]();
let pairs = Array.from(iter);
for (let pair of pairs) {
  console.log(pair[0] + ', ' + pair[1]);
}

toString⁹⁺

toString(): string

Obtains search parameters that are serialized as a string and, if necessary, percent-encodes the characters in the string.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
string	String of serialized search parameters, which is percent-encoded if necessary.

Example

let urlObject = url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new url.URLParams(urlObject.search.slice(1));
params.append('fod', '3');
console.log(params.toString()); // Output 'fod=1&bard=2&fod=3'

URL

Provides APIs for parsing, constructing, standardizing, and encoding URL strings.

Attributes

System capability: SystemCapability.Utils.Lang

Name	Type	Readable	Writable	Description
hash	string	Yes	Yes	String that contains a harsh mark (#) followed by the fragment identifier of a URL. Atomic service API: This API can be used in atomic services since API version 11.
host	string	Yes	Yes	Host information in a URL. Atomic service API: This API can be used in atomic services since API version 11.
hostname	string	Yes	Yes	Hostname (without the port) in a URL. Atomic service API: This API can be used in atomic services since API version 11.
href	string	Yes	Yes	String that contains the whole URL. Atomic service API: This API can be used in atomic services since API version 11.
origin	string	Yes	No	Read-only string that contains the Unicode serialization of the origin of the represented URL. Atomic service API: This API can be used in atomic services since API version 11.
password	string	Yes	Yes	Password in a URL. Atomic service API: This API can be used in atomic services since API version 11.
pathname	string	Yes	Yes	Path in a URL. Atomic service API: This API can be used in atomic services since API version 11.
port	string	Yes	Yes	Port in a URL. Atomic service API: This API can be used in atomic services since API version 11.
protocol	string	Yes	Yes	Protocol in a URL. Atomic service API: This API can be used in atomic services since API version 11.
search	string	Yes	Yes	Serialized query string in a URL. Atomic service API: This API can be used in atomic services since API version 11.
searchParams(deprecated)	URLSearchParams	Yes	No	URLSearchParams object allowing access to the query parameters in a URL. - NOTE: This attribute is supported since API version 7 and is deprecated since API version 9. You are advised to use params9+ instead.
params9+	URLParams	Yes	No	URLParams object allowing access to the query parameters in a URL. Atomic service API: This API can be used in atomic services since API version 11.
username	string	Yes	Yes	Username in a URL. Atomic service API: This API can be used in atomic services since API version 11.

Example

let that = url.URL.parseURL('http://username:password@host:8080/directory/file?foo=1&bar=2#fragment');
console.log("hash " + that.hash) // hash #fragment
console.log("host " + that.host) // host host:8080
console.log("hostname " + that.hostname) // hostname host
console.log("href " + that.href) // href http://username:password@host:8080/directory/file?foo=1&bar=2#fragment
console.log("origin " + that.origin) // origin http://host:8080
console.log("password " + that.password) // password password
console.log("pathname " + that.pathname) // pathname /directory/file
console.log("port " + that.port) // port 8080
console.log("protocol " + that.protocol) // protocol http:
console.log("search " + that.search) // search ?foo=1&bar=2
console.log("username " + that.username) // username username
// The return value of that.params is a URLParams object.
console.log("params: foo " + that.params.get("foo")) // params: foo 1

constructor^(deprecated)

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use parseURL⁹⁺ instead.

constructor(url: string, base?: string|URL)

Creates a URL.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
url	string	Yes	A string representing an absolute or a relative URL. In the case of a relative URL, you must specify base to parse the final URL. In the case of an absolute URL, the passed base will be ignored.
base	string |URL	No	Either a string or an object. The default value is undefined. - string: string. - URL: URL object. - This parameter is used when url is a relative URL.

Example

let mm = 'https://username:password@host:8080';
let a = new url.URL("/", mm); // Output 'https://username:password@host:8080/';
let b = new url.URL(mm); // Output 'https://username:password@host:8080/';
new url.URL('path/path1', b); // Output 'https://username:password@host:8080/path/path1';
let c = new url.URL('/path/path1', b);  // Output 'https://username:password@host:8080/path/path1'; 
new url.URL('/path/path1', c); // Output 'https://username:password@host:8080/path/path1';
new url.URL('/path/path1', a); // Output 'https://username:password@host:8080/path/path1';
new url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toot"); // Output https://www.exampleUrl/path/path1
new url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
new url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
new url.URL('https://www.example.com', ); // Output https://www.example.com/
new url.URL('https://www.example.com', b); // Output https://www.example.com/

constructor⁹⁺

constructor()

A no-argument constructor used to create a URL. It returns a URL object after parseURL is called. It is not used independently.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

parseURL⁹⁺

static parseURL(url: string, base?: string|URL): URL

Parses a URL.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
url	string	Yes	A string representing an absolute or a relative URL. In the case of a relative URL, you must specify base to parse the final URL. In the case of an absolute URL, the passed base will be ignored.
base	string |URL	No	Either a string or an object. The default value is undefined. - string: string. - URL: URL object. - This parameter is used when url is a relative URL.

NOTE

If url is a relative URL, the URL parsed by calling this API is not merely a concatenation of url and base. When url is a relative path, it is parsed relative to the current directory of the passed base, taking into account all path segments before the last slash in the path of base, but excluding the following part (see example url1). When url points to a root directory, it is parsed relative to the origin of base (see example url2).

Error codes

For details about the error codes, see Universal Error Codes and Utils Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
10200002	Invalid url string.

Example

let mm = 'https://username:password@host:8080/test/test1/test3';
let urlObject = url.URL.parseURL(mm);
let result = urlObject.toString(); // Output 'https://username:password@host:8080/test/test1/test3'
// If url is a relative path, the path in the base parameter is test/test1, and the path of the parsed URL is /test/path2/path3.
let url1 = url.URL.parseURL('path2/path3', 'https://www.example.com/test/test1'); // Output 'https://www.example.com/test/path2/path3'
// If url is a root directory, the path in the base parameter is /test/test1/test3, and the path of the parsed URL is /path1/path2.
let url2 = url.URL.parseURL('/path1/path2', urlObject); // Output 'https://username:password@host:8080/path1/path2'
url.URL.parseURL('/path/path1', "https://www.exampleUrl/fr-FR/toot"); // Output 'https://www.exampleUrl/path/path1'
url.URL.parseURL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
url.URL.parseURL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
url.URL.parseURL('https://www.example.com', ); // Output 'https://www.example.com/'
url.URL.parseURL('https://www.example.com', urlObject); // Output 'https://www.example.com/'

toString

toString(): string

Converts the parsed URL into a string.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
string	Website address in a serialized string.

Example

const urlObject = url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = urlObject.toString(); // Output 'https://username:password@host:8080/directory/file?query=pppppp#qwer=da'

toJSON

toJSON(): string

Converts the parsed URL into a JSON string.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
string	Website address in a serialized string.

Example

const urlObject = url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = urlObject.toJSON();

URLSearchParams^(deprecated)

Defines APIs for handling URL query strings.

This class is deprecated since API version 9. You are advised to use URLParams instead.

constructor^(deprecated)

constructor(init?: string[][]|Record&lt;string, string&gt;|string|URLSearchParams)

A constructor used to create a URLSearchParams instance.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.constructor⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
init	string[][] |Record<string, string> |string |URLSearchParams	No	Input parameter objects, which include the following: - string[][]: two-dimensional string array. - Record<string, string>: list of objects. - string: string. - URLSearchParams: object. The default value is null.

Example

let objectParams = new url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
let objectParams1 = new url.URLSearchParams({"fod" : '1' , "bard" : '2'});
let objectParams2 = new url.URLSearchParams('?fod=1&bard=2');
let urlObject = new url.URL('https://developer.mozilla.org/?fod=1&bard=2');
let params = new url.URLSearchParams(urlObject.search);

append^(deprecated)

append(name: string, value: string): void

Appends a key-value pair into the query string.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.append⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the key-value pair to append.
value	string	Yes	Value of the key-value pair to append.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLSearchParams(urlObject.search.slice(1));
paramsObject.append('fod', '3');

delete^(deprecated)

delete(name: string): void

Deletes key-value pairs of the specified key.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.delete⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the key-value pairs to delete.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLSearchParams(urlObject.search.slice(1));
paramsObject.delete('fod');

getAll^(deprecated)

getAll(name: string): string[]

Obtains all the key-value pairs based on the specified key.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.getAll⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Target key.

Return value

Type	Description
string[]	All key-value pairs matching the specified key.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new url.URLSearchParams(urlObject.search.slice(1));
params.append('fod', '3'); // Add a second value for the fod parameter.
console.log(params.getAll('fod').toString()) // Output ["1","3"].

entries^(deprecated)

entries(): IterableIterator<[string, string]>

Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and the first and second fields of each array are the key and value respectively.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.entries⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<[string, string]>	ES6 iterator.

Example

let searchParamsObject = new url.URLSearchParams("keyName1=valueName1&keyName2=valueName2");
let iter: Iterable<Object[]> = searchParamsObject.entries();
let pairs = Array.from(iter);
for (let pair of pairs) { // Show keyName/valueName pairs
  console.log(pair[0]+ ', '+ pair[1]);
}

forEach^(deprecated)

forEach(callbackFn: (value: string, key: string, searchParams: URLSearchParams) => void, thisArg?: Object): void

Traverses the key-value pairs in the URLSearchParams instance by using a callback.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.forEach⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
callbackFn	function	Yes	Callback invoked to traverse the key-value pairs in the URLSearchParams instance.
thisArg	Object	No	Value of this to use when callbackFn is invoked. The default value is this object.

Table 1 callbackFn parameter description

Name	Type	Mandatory	Description
value	string	Yes	Value that is currently traversed.
key	string	Yes	Key that is currently traversed.
searchParams	URLSearchParams	Yes	Instance that invokes the forEach method.

Example

const myURLObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
myURLObject.searchParams.forEach((value, name, searchParams) => {
    console.log(name, value, myURLObject.searchParams === searchParams);
});

get^(deprecated)

get(name: string): string|null

Obtains the value of the first key-value pair based on the specified key.

NOTE

If the key-value pair does not exist, undefined is returned. This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.get⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key specified to obtain the value.

Return value

Type	Description
string	Returns the value of the first key-value pair if obtained.
null	Returns null if no value is obtained.

Example

let paramsObject = new url.URLSearchParams('name=Jonathan&age=18');
let name = paramsObject.get("name"); // is the string "Jonathan"
let age = paramsObject.get("age"); // is the string '18'
let getObj = paramsObject.get("abc"); // undefined

has^(deprecated)

has(name: string): boolean

Checks whether a key has a value.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.has⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key specified to search for its value.

Return value

Type	Description
boolean	Check result. The value true means that the key has a value, and false means the opposite.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLSearchParams(urlObject.search.slice(1));
paramsObject.has('bard') === true;

set^(deprecated)

set(name: string, value: string): void

Sets the value for a key. If key-value pairs matching the specified key exist, the value of the first key-value pair will be set to the specified value and other key-value pairs will be deleted. Otherwise, the key-value pair will be appended to the query string.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.set⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Key of the value to set.
value	string	Yes	Value to set.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new url.URLSearchParams(urlObject.search.slice(1));
paramsObject.set('baz', '3'); // Add a third parameter.

sort^(deprecated)

sort(): void

Sorts all key-value pairs contained in this object based on the Unicode code points of the keys and returns undefined. This method uses a stable sorting algorithm, that is, the relative order between key-value pairs with equal keys is retained.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.sort⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Example

let searchParamsObject = new url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
searchParamsObject.sort(); // Sort the key/value pairs
console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=4&c=3&d=2

keys^(deprecated)

keys(): IterableIterator&lt;string&gt;

Obtains an ES6 iterator that contains the keys of all the key-value pairs.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.keys⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<string>	ES6 iterator that contains the keys of all the key-value pairs.

Example

let searchParamsObject = new url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
let keys = Array.from(searchParamsObject.keys());
for (let key of keys) { // Output key-value pairs
  console.log(key);
}

values^(deprecated)

values(): IterableIterator&lt;string&gt;

Obtains an ES6 iterator that contains the values of all the key-value pairs.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.values⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<string>	ES6 iterator that contains the values of all the key-value pairs.

Example

let searchParams = new url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
let values = Array.from(searchParams.values());
for (let value of values) {
  console.log(value);
}

[Symbol.iterator]^(deprecated)

[Symbol.iterator](): IterableIterator&lt;[string, string]&gt;

Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and the first and second fields of each array are the key and value respectively.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.[Symbol.iterator]⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
IterableIterator<[string, string]>	ES6 iterator.

Example

const paramsObject = new url.URLSearchParams('fod=bay&edg=bap');
let iter: Iterable<Object[]> = paramsObject[Symbol.iterator]();
let pairs = Array.from(iter);
for (let pair of pairs) {
  console.log(pair[0] + ', ' + pair[1]);
}

toString^(deprecated)

toString(): string

Obtains search parameters that are serialized as a string and, if necessary, percent-encodes the characters in the string.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use URLParams.toString⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
string	String of serialized search parameters, which is percent-encoded if necessary.

Example

let urlObject = new url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new url.URLSearchParams(urlObject.search.slice(1));
params.append('fod', '3');
console.log(params.toString()); // Output 'fod=1&bard=2&fod=3'

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkTS

harmony 鸿蒙Compilation Toolchain Error Codes

harmony 鸿蒙TypeScript Compiler Error Codes

harmony 鸿蒙Utils Error Codes

harmony 鸿蒙js-apis-arkts-collections

harmony 鸿蒙@arkts.math.Decimal (High-Precision Math Library Decimal)

harmony 鸿蒙@arkts.lang (ArkTS Base Capability)

harmony 鸿蒙@arkts.utils (ArkTS Utils)

harmony 鸿蒙@ohos.util.ArrayList (Linear Container ArrayList)

harmony 鸿蒙@ohos.buffer (Buffer)