Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b7b3e718
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b7b3e718
编写于
10月 21, 2022
作者:
Z
zhangyouyou
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
https://gitee.com/openharmony/docs/issues/I5WZQT
Signed-off-by:
N
zhangyouyou
<
zhangyouyou2@huawei.com
>
上级
5d8e6806
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
453 addition
and
20 deletion
+453
-20
zh-cn/application-dev/reference/apis/js-apis-uri.md
zh-cn/application-dev/reference/apis/js-apis-uri.md
+30
-1
zh-cn/application-dev/reference/apis/js-apis-url.md
zh-cn/application-dev/reference/apis/js-apis-url.md
+423
-19
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-uri.md
浏览文件 @
b7b3e718
...
...
@@ -76,7 +76,9 @@ result.toString()
```
### equals
### equals<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[equalsTo<sup>9+</sup>](#equalsto9)替代。
equals(other: URI): boolean
...
...
@@ -103,6 +105,33 @@ const uriInstance = new uri.URI('http://username:password@host:8080/directory/fi
const
uriInstance1
=
new
uri
.
URI
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da#fragment
'
);
uriInstance
.
equals
(
uriInstance1
);
```
### equalsTo<sup>9+</sup>
equalsTo(other: URI): boolean
判断此URI是否与其他URI对象相等。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| other |
[
URI
](
#uri
)
| 是 | 需要比较的URI对象。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示相等,否则返回false。 |
**示例:**
```
js
const
uriInstance
=
new
uri
.
URI
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
const
uriInstance1
=
new
uri
.
URI
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da#fragment
'
);
uriInstance
.
equalsTo
(
uriInstance1
);
```
### checkIsAbsolute
...
...
zh-cn/application-dev/reference/apis/js-apis-url.md
浏览文件 @
b7b3e718
...
...
@@ -3,17 +3,374 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
import Url from '@ohos.url'
```
## URLParams<sup>9+</sup>
## URLSearchParams
### constructor<sup>9+</sup>
### constructor
constructor(init?: string
[][]
| Record
<
string, string
>
| string | URLParams)
URLParams的构造函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| init | string
[][]
\|
Record
<
string, string
>
\|
string
\|
URLParams | 否 | 入参对象。
<br/>
- string
[][]
:字符串二维数组
<br/>
- Record
<
string, string
>
:对象列表
<br/>
- string:字符串
<br/>
- URLParams:对象 |
**示例:**
```
js
let
objectParams
=
new
Url
.
URLParams
([
[
'
user1
'
,
'
abc1
'
],
[
'
query2
'
,
'
first2
'
],
[
'
query3
'
,
'
second3
'
]
]);
let
objectParams1
=
new
Url
.
URLParams
({
"
fod
"
:
'
1
'
,
"
bard
"
:
'
2
'
});
let
objectParams2
=
new
Url
.
URLParams
(
'
?fod=1&bard=2
'
);
let
urlObject
=
new
Url
.
URL
(
'
https://developer.mozilla.org/?fod=1&bard=2
'
);
let
params
=
new
Url
.
URLParams
(
urlObject
.
search
);
```
### append<sup>9+</sup>
append(name: string, value: string): void
将新的键值对插入到查询字符串。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要插入搜索参数的键名。 |
| value | string | 是 | 需要插入搜索参数的值。 |
**示例:**
```
js
let
urlObject
=
new
Url
.
URL
(
'
https://developer.exampleUrl/?fod=1&bard=2
'
);
let
paramsObject
=
new
Url
.
URLParams
(
urlObject
.
search
.
slice
(
1
));
paramsObject
.
append
(
'
fod
'
,
'
3
'
);
```
### delete<sup>9+</sup>
delete(name: string): void
删除指定名称的键值对。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要删除的键值名称。 |
**示例:**
```
js
let
urlObject
=
new
Url
.
URL
(
'
https://developer.exampleUrl/?fod=1&bard=2
'
);
let
paramsobject
=
new
Url
.
URLParams
(
urlObject
.
search
.
slice
(
1
));
paramsobject
.
delete
(
'
fod
'
);
```
### getAll<sup>9+</sup>
getAll(name: string): string[]
获取指定名称的所有键值对。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 指定的键值名称。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string[] | 返回指定名称的所有键值对。 |
**示例:**
```
js
let
urlObject
=
new
Url
.
URL
(
'
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<sup>9+</sup>
entries(): IterableIterator
<
[
string
,
string
]
>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator
<
[string, string]
>
| 返回一个ES6的迭代器。 |
**示例:**
```
js
let
searchParamsObject
=
new
Url
.
URLParams
(
"
keyName1=valueName1&keyName2=valueName2
"
);
for
(
var
pair
of
searchParamsObject
.
entries
())
{
// Show keyName/valueName pairs
console
.
log
(
pair
[
0
]
+
'
,
'
+
pair
[
1
]);
}
```
### forEach<sup>9+</sup>
forEach(callbackfn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
通过回调函数来遍历URLSearchParams实例对象上的键值对。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackfn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值 |
**表1**
callbackfn的参数说明
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 当前遍历到的键值。 |
| key | string | 是 | 当前遍历到的键名。 |
| searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |
**示例:**
```
js
const
myURLObject
=
new
Url
.
URL
(
'
https://developer.exampleUrl/?fod=1&bard=2
'
);
myURLObject
.
URLParams
.
forEach
((
value
,
name
,
searchParams
)
=>
{
console
.
log
(
name
,
value
,
myURLObject
.
searchParams
===
searchParams
);
});
```
### get<sup>9+</sup>
get(name: string): string | null
获取指定名称对应的第一个值。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 指定键值对的名称。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 返回第一个值。 |
| null | 如果没找到,返回 null。 |
**示例:**
```
js
let
paramsObject
=
new
Url
.
URLParams
(
'
name=Jonathan&age=18
'
);
let
name
=
paramsObject
.
get
(
"
name
"
);
// is the string "Jonathan"
let
age
=
parseInt
(
paramsObject
.
get
(
"
age
"
),
10
);
// is the number 18
```
### has<sup>9+</sup>
has(name: string): boolean
判断一个指定的键名对应的值是否存在。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 要查找的参数的键名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 是否存在相对应的key值,存在返回true,否则返回false。 |
**示例:**
```
js
let
urlObject
=
new
Url
.
URL
(
'
https://developer.exampleUrl/?fod=1&bard=2
'
);
let
paramsObject
=
new
Url
.
URLParams
(
urlObject
.
search
.
slice
(
1
));
paramsObject
.
has
(
'
bard
'
)
===
true
;
```
### set<sup>9+</sup>
set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 将要设置的参数的键值名。 |
| value | string | 是 | 所要设置的参数值。 |
**示例:**
```
js
let
urlObject
=
new
Url
.
URL
(
'
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<sup>9+</sup>
sort(): void
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
**系统能力:**
SystemCapability.Utils.Lang
**示例:**
```
js
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=2&c=3&d=4
```
### keys<sup>9+</sup>
keys(): IterableIterator
<
string
>
返回一个所有键值对的name的ES6迭代器。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator
<
string
>
| 返回一个所有键值对的name的ES6迭代器。 |
**示例:**
```
js
let
searchParamsObject
=
new
Url
.
URLParams
(
"
key1=value1&key2=value2
"
);
// Create a URLSearchParamsObject object for testing
for
(
var
key
of
searchParamsObject
.
keys
())
{
// Output key-value pairs
console
.
log
(
key
);
}
```
### values<sup>9+</sup>
values(): IterableIterator
<
string
>
返回一个所有键值对的value的ES6迭代器。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator
<
string
>
| 返回一个所有键值对的value的ES6迭代器。 |
**示例:**
```
js
let
searchParams
=
new
Url
.
URLParams
(
"
key1=value1&key2=value2
"
);
// Create a URLSearchParamsObject object for testing
for
(
var
value
of
searchParams
.
values
())
{
console
.
log
(
value
);
}
```
### [Symbol.iterator]<sup>9+</sup>
[Symbol.iterator]
\(
): IterableIterator
<
[string, string]
>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator
<
[string, string]
>
| 返回一个ES6的迭代器。 |
**示例:**
```
js
const
paramsObject
=
new
Url
.
URLParams
(
'
fod=bay&edg=bap
'
);
for
(
const
[
name
,
value
]
of
paramsObject
)
{
console
.
log
(
name
,
value
);
}
```
### tostring<sup>9+</sup>
toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |
**示例:**
```
js
let
url
=
new
Url
.
URL
(
'
https://developer.exampleUrl/?fod=1&bard=2
'
);
let
params
=
new
Url
.
URLParams
(
url
.
search
.
slice
(
1
));
params
.
append
(
'
fod
'
,
'
3
'
);
console
.
log
(
params
.
toString
());
```
## URLSearchParams<sup>(deprecated)</sup>
### constructor<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>](#constructor9+)替代。
constructor(init?: string
[][]
| Record
<
string, string
>
| string | URLSearchParams)
...
...
@@ -37,8 +394,10 @@ let urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2');
let
params
=
new
Url
.
URLSearchParams
(
urlObject
.
search
);
```
### append<sup>(deprecated)</sup>
### append
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.append<sup>9+</sup>](#append9)替代。
append(name: string, value: string): void
...
...
@@ -61,8 +420,10 @@ let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject
.
append
(
'
fod
'
,
'
3
'
);
```
### delete<sup>(deprecated)</sup>
### delete
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.delete<sup>9+</sup>](#delete9)替代。
delete(name: string): void
...
...
@@ -84,8 +445,10 @@ let paramsobject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsobject
.
delete
(
'
fod
'
);
```
### getAll<sup>(deprecated)</sup>
### getAll
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.getAll<sup>9+</sup>](#getall9)替代。
getAll(name: string): string[]
...
...
@@ -114,8 +477,10 @@ params.append('fod', '3'); // Add a second value for the fod parameter.
console
.
log
(
params
.
getAll
(
'
fod
'
).
toString
())
// Output ["1","3"].
```
### entries<sup>(deprecated)</sup>
### entries
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.entries<sup>9+</sup>](#entries9)替代。
entries(): IterableIterator
<
[
string
,
string
]
>
...
...
@@ -139,7 +504,9 @@ for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pair
```
### forEach
### forEach<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.forEach<sup>9+</sup>](#foreach9)替代。
forEach(callbackfn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
...
...
@@ -172,7 +539,9 @@ myURLObject.searchParams.forEach((value, name, searchParams) => {
```
### get
### get<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.get<sup>9+</sup>](#get9)替代。
get(name: string): string | null
...
...
@@ -202,7 +571,9 @@ let age = parseInt(paramsObject.get("age"), 10); // is the number 18
```
### has
### has<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.has<sup>9+</sup>](#has9)替代。
has(name: string): boolean
...
...
@@ -231,7 +602,9 @@ paramsObject.has('bard') === true;
```
### set
### set<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.set<sup>9+</sup>](#set9)替代。
set(name: string, value: string): void
...
...
@@ -255,7 +628,9 @@ paramsObject.set('baz', '3'); // Add a third parameter.
```
### sort
### sort<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.sort<sup>9+</sup>](#sort9)替代。
sort(): void
...
...
@@ -272,7 +647,9 @@ console.log(searchParamsObject.toString()); // Display the sorted query string /
```
### keys
### keys<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.keys<sup>9+</sup>](#keys9)替代。
keys(): IterableIterator
<
string
>
...
...
@@ -296,7 +673,9 @@ for (var key of searchParamsObject .keys()) { // Output key-value pairs
```
### values
### values<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.values<sup>9+</sup>](#values9)替代。
values(): IterableIterator
<
string
>
...
...
@@ -320,7 +699,9 @@ for (var value of searchParams.values()) {
```
### [Symbol.iterator]
### [Symbol.iterator]<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.[Symbol.iterator]<sup>9+</sup>](#symbol.iterator9)替代。
[Symbol.iterator]
\(
): IterableIterator
<
[string, string]
>
...
...
@@ -343,8 +724,9 @@ for (const [name, value] of paramsObject) {
}
```
### tostring
### tostring<sup>(deprecated)</sup>
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.tostring<sup>9+</sup>](#tostring9)替代。
toString(): string
...
...
@@ -367,7 +749,6 @@ params.append('fod', '3');
console
.
log
(
params
.
toString
());
```
## URL
### 属性
...
...
@@ -387,12 +768,13 @@ console.log(params.toString());
| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 |
| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 |
| searchParams | URLsearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 |
| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
| username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
### constructor
constructor(url: string, base?: string | URL)
constructor(url
?
: string, base?: string | URL)
URL的构造函数。
...
...
@@ -422,6 +804,27 @@ new Url.URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/
new
Url
.
URL
(
'
http://www.shanxi.com
'
,
b
);
// Output http://www.shanxi.com/
```
### parseURL<sup>9+</sup>
static parseURL(inputUrl : string, inputBase ?: string | URL)
URL静态成员函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| inputUrl | string | 是 | 入参对象。 |
| inputBase | string
\|
URL | 否 | 入参字符串或者对象。
<br/>
- string:字符串
<br/>
- URL:字符串或对象 |
**示例:**
```
js
let
mm
=
'
http://username:password@host:8080
'
;
Url
.
URL
.
parseURL
(
mm
);
// Output 'http://username:password@host:8080/';
```
### tostring
...
...
@@ -464,3 +867,4 @@ toJSON(): string
const
url
=
new
Url
.
URL
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
url
.
toJSON
();
```
<!--no_check-->
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录