1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.url.d.ts 42.70 KB
一键复制 编辑 原始数据 按行查看 历史
suchongwei 提交于 2024-08-04 15:27 +08:00 . commonlibrary api doc add @type and @typedef 
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247
/*
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkTS
*/
/**
* The url module provides utilities for URL resolution and parsing.
*
* @namespace url
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The url module provides utilities for URL resolution and parsing.
*
* @namespace url
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The url module provides utilities for URL resolution and parsing.
*
* @namespace url
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace url {
/**
* The URLSearchParams interface defines some practical methods to process URL query strings.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams
* @name URLSearchParams
*/
class URLSearchParams {
/**
* A parameterized constructor used to create an URLSearchParams instance.
* As the input parameter of the constructor function, init supports four types.
* The input parameter is a character string two-dimensional array.
* The input parameter is the object list.
* The input parameter is a character string.
* The input parameter is the URLSearchParams object.
*
* @param { string[][] | Record<string, string> | string | URLSearchParams } init - init init
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.constructor
*/
constructor(init?: string[][] | Record<string, string> | string | URLSearchParams);
/**
* Appends a specified key/value pair as a new search parameter.
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.append
*/
append(name: string, value: string): void;
/**
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.delete
*/
delete(name: string): void;
/**
* Returns all key-value pairs associated with a given search parameter as an array.
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.getAll
*/
getAll(name: string): string[];
/**
* Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
*
* @returns { IterableIterator<[string, string]> } Returns an iterator for ES6.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.entries
*/
entries(): IterableIterator<[string, string]>;
/**
* Callback functions are used to traverse key-value pairs on the URLSearchParams instance object.
*
* @param { function } callbackFn - callbackFn callbackFn Current traversal key value.
* @param { Object } thisArg - thisArg thisArg thisArg to be used as this value for when callbackFn is called
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.forEach
*/
forEach(callbackFn: (value: string, key: string, searchParams: URLSearchParams) => void, thisArg?: Object): void;
/**
* Returns the first value associated to the given search parameter.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.get
*/
get(name: string): string | null;
/**
* Returns a Boolean that indicates whether a parameter with the specified name exists.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.has
*/
has(name: string): boolean;
/**
* Sets the value associated with a given search parameter to the
* given value. If there were several matching values, this method
* deletes the others. If the search parameter doesn't exist, this
* method creates it.
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.set
*/
set(name: string, value: string): void;
/**
* Sort all key/value pairs contained in this object in place and return undefined.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.sort
*/
sort(): void;
/**
* Returns an iterator allowing to go through all keys contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the names of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.keys
*/
keys(): IterableIterator<string>;
/**
* Returns an iterator allowing to go through all values contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the values of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.values
*/
values(): IterableIterator<string>;
/**
* Returns an iterator allowing to go through all key/value
* pairs contained in this object.
* @returns { IterableIterator<[string, string]> } Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.[Symbol.iterator]
*/
[Symbol.iterator](): IterableIterator<[string, string]>;
/**
* Returns a query string suitable for use in a URL.
*
* @returns { string } Returns a search parameter serialized as a string, percent-encoded if necessary.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URLParams.toString
*/
toString(): string;
}
/**
* The URLParams interface defines some practical methods to process URL query strings.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
* @name URLParams
*/
/**
* The URLParams interface defines some practical methods to process URL query strings.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
* @name URLParams
*/
/**
* The URLParams interface defines some practical methods to process URL query strings.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
* @name URLParams
*/
class URLParams {
/**
* A parameterized constructor used to create an URLParams instance.
* As the input parameter of the constructor function, init supports four types.
* The input parameter is a character string two-dimensional array.
* The input parameter is the object list.
* The input parameter is a character string.
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* A parameterized constructor used to create an URLParams instance.
* As the input parameter of the constructor function, init supports four types.
* The input parameter is a character string two-dimensional array.
* The input parameter is the object list.
* The input parameter is a character string.
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A parameterized constructor used to create an URLParams instance.
* As the input parameter of the constructor function, init supports four types.
* The input parameter is a character string two-dimensional array.
* The input parameter is the object list.
* The input parameter is a character string.
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(init?: string[][] | Record<string, string> | string | URLParams);
/**
* Appends a specified key/value pair as a new search parameter.
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Appends a specified key/value pair as a new search parameter.
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Appends a specified key/value pair as a new search parameter.
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
append(name: string, value: string): void;
/**
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
delete(name: string): void;
/**
* Returns all key-value pairs associated with a given search parameter as an array.
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns all key-value pairs associated with a given search parameter as an array.
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns all key-value pairs associated with a given search parameter as an array.
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
getAll(name: string): string[];
/**
* Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
*
* @returns { IterableIterator<[string, string]> } Returns an iterator for ES6.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
*
* @returns { IterableIterator<[string, string]> } Returns an iterator for ES6.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
*
* @returns { IterableIterator<[string, string]> } Returns an iterator for ES6.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
entries(): IterableIterator<[string, string]>;
/**
* Callback functions are used to traverse key-value pairs on the URLParams instance object.
*
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Callback functions are used to traverse key-value pairs on the URLParams instance object.
*
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Callback functions are used to traverse key-value pairs on the URLParams instance object.
*
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
forEach(callbackFn: (value: string, key: string, searchParams: URLParams) => void, thisArg?: Object): void;
/**
* Returns the first value associated to the given search parameter.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns the first value associated to the given search parameter.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the first value associated to the given search parameter.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
get(name: string): string | null;
/**
* Returns a Boolean that indicates whether a parameter with the specified name exists.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a Boolean that indicates whether a parameter with the specified name exists.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a Boolean that indicates whether a parameter with the specified name exists.
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
has(name: string): boolean;
/**
* Sets the value associated with a given search parameter to the
* given value. If there were several matching values, this method
* deletes the others. If the search parameter doesn't exist, this
* method creates it.
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Sets the value associated with a given search parameter to the
* given value. If there were several matching values, this method
* deletes the others. If the search parameter doesn't exist, this
* method creates it.
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets the value associated with a given search parameter to the
* given value. If there were several matching values, this method
* deletes the others. If the search parameter doesn't exist, this
* method creates it.
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
set(name: string, value: string): void;
/**
* Sort all key/value pairs contained in this object in place and return undefined.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Sort all key/value pairs contained in this object in place and return undefined.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sort all key/value pairs contained in this object in place and return undefined.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
sort(): void;
/**
* Returns an iterator allowing to go through all keys contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the names of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns an iterator allowing to go through all keys contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the names of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns an iterator allowing to go through all keys contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the names of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
keys(): IterableIterator<string>;
/**
* Returns an iterator allowing to go through all values contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the values of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns an iterator allowing to go through all values contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the values of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns an iterator allowing to go through all values contained in this object.
*
* @returns { IterableIterator<string> } Returns an ES6 Iterator over the values of each name-value pair.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
values(): IterableIterator<string>;
/**
* Returns an iterator allowing to go through all key/value
* pairs contained in this object.
*
* @returns { IterableIterator<[string, string]> } Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns an iterator allowing to go through all key/value
* pairs contained in this object.
*
* @returns { IterableIterator<[string, string]> } Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns an iterator allowing to go through all key/value
* pairs contained in this object.
*
* @returns { IterableIterator<[string, string]> } Returns an ES6 iterator. Each item of the iterator is a JavaScript Array.
* The first item of Array is name, and the second item of Array is value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
[Symbol.iterator](): IterableIterator<[string, string]>;
/**
* Returns a query string suitable for use in a URL.
*
* @returns { string } Returns a search parameter serialized as a string, percent-encoded if necessary.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a query string suitable for use in a URL.
*
* @returns { string } Returns a search parameter serialized as a string, percent-encoded if necessary.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a query string suitable for use in a URL.
*
* @returns { string } Returns a search parameter serialized as a string, percent-encoded if necessary.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
toString(): string;
}
/**
* The interface of URL is used to parse, construct, normalize, and encode URLs.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @name URL
*/
/**
* The interface of URL is used to parse, construct, normalize, and encode URLs.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
* @name URL
*/
/**
* The interface of URL is used to parse, construct, normalize, and encode URLs.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
* @name URL
*/
class URL {
/**
* URL constructor, which is used to instantiate a URL object.
* url: Absolute or relative input URL to resolve. Base is required if input is relative.
* If input is an absolute value, base ignores the value.
* base: Base URL to parse if input is not absolute.
*
* @param { string } url - url url
* @param { string | URL } base - base base
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URL.parseURL
*/
constructor(url: string, base?: string | URL);
/**
* URL constructor, which is used to instantiate a URL object.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* URL constructor, which is used to instantiate a URL object.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* URL constructor, which is used to instantiate a URL object.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor();
/**
* Replaces the original constructor to process arguments and return a url object.
*
* @param { string } url - url url Absolute or relative input URL to resolve. Base is required if input is relative.
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Replaces the original constructor to process arguments and return a url object.
*
* @param { string } url - url url Absolute or relative input URL to resolve. Base is required if input is relative.
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Replaces the original constructor to process arguments and return a url object.
*
* @param { string } url - url url Absolute or relative input URL to resolve. Base is required if input is relative.
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
static parseURL(url: string, base?: string | URL): URL;
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
toString(): string;
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the serialized URL as a string.
*
* @returns { string } Returns the serialized URL as a string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
toJSON(): string;
/**
* Gets and sets the fragment portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the fragment portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the fragment portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
hash: string;
/**
* Gets and sets the host portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the host portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the host portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
host: string;
/**
* Gets and sets the host name portion of the URL,not include the port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the host name portion of the URL,not include the port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the host name portion of the URL,not include the port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
hostname: string;
/**
* Gets and sets the serialized URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the serialized URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the serialized URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
href: string;
/**
* Gets the read-only serialization of the URL's origin.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets the read-only serialization of the URL's origin.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the read-only serialization of the URL's origin.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly origin: string;
/**
* Gets and sets the password portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the password portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the password portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
password: string;
/**
* Gets and sets the path portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the path portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the path portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
pathname: string;
/**
* Gets and sets the port portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the port portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the port portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
port: string;
/**
* Gets and sets the protocol portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the protocol portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the protocol portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
protocol: string;
/**
* Gets and sets the serialized query portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the serialized query portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the serialized query portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
search: string;
/**
* Gets the URLSearchParams object that represents the URL query parameter.
* This property is read-only, but URLSearchParams provides an object that can be used to change
* the URL instance. To replace the entire query parameter for a URL, use url.searchsetter.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.url.URL.params
*/
readonly searchParams: URLSearchParams;
/**
* Gets the URLParams object that represents the URL query parameter.
* This property is read-only, but URLParams provides an object that can be used to change
* the URL instance. To replace the entire query parameter for a URL, use url.searchsetter.
*
* @type { URLParams }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Gets the URLParams object that represents the URL query parameter.
* This property is read-only, but URLParams provides an object that can be used to change
* the URL instance. To replace the entire query parameter for a URL, use url.searchsetter.
*
* @type { URLParams }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the URLParams object that represents the URL query parameter.
* This property is read-only, but URLParams provides an object that can be used to change
* the URL instance. To replace the entire query parameter for a URL, use url.searchsetter.
*
* @type { URLParams }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly params: URLParams;
/**
* Gets and sets the username portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Gets and sets the username portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets and sets the username portion of the URL.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
username: string;
}
}
export default url;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助