Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
35f5dadb
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
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,发现更多精彩内容 >>
未验证
提交
35f5dadb
编写于
12月 26, 2022
作者:
O
openharmony_ci
提交者:
Gitee
12月 26, 2022
浏览文件
操作
浏览文件
下载
差异文件
!12853 修改URL属性说明问题
Merge pull request !12853 from jiangkai43/master
上级
e9558582
df7291f8
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
17 addition
and
149 deletion
+17
-149
zh-cn/application-dev/reference/apis/js-apis-url.md
zh-cn/application-dev/reference/apis/js-apis-url.md
+17
-149
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-url.md
浏览文件 @
35f5dadb
...
...
@@ -11,7 +11,6 @@ import Url from '@ohos.url'
```
## URLParams<sup>9+</sup>
### constructor<sup>9+</sup>
constructor(init?: string
[][]
| Record
<
string, string
>
| string | URLSearchParams)
...
...
@@ -384,20 +383,20 @@ console.log(params.toString());
| port | string | 是 | 是 | 获取和设置URL的端口部分。 |
| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 |
| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 |
| searchParams
| URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象
。 |
|
URLParams | URLParams
| 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
| searchParams
<sup>
(deprecated)
</sup>
|
[
URLSearchParams
](
#urlsearchparamsdeprecated
)
| 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。
<br/>
-
**说明:**
此属性从API version 7开始支持,从API version 9开始被废弃。建议使用params
<sup>
9+
</sup>
替代
。 |
|
params
<sup>
9+
</sup>
|
[
URLParams
](
#urlparams9
)
| 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
| username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
### constructor<sup>(deprecated)</sup>
constructor(url: string, base?: string | URL)
URL的构造函数。
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[parseURL<sup>9+</sup>](#parseurl9)替代。
constructor(url: string, base?: string | URL)
URL的构造函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
...
...
@@ -410,13 +409,13 @@ URL的构造函数。
**示例:**
```
js
let
mm
=
'
http://username:password@host:8080
'
;
let
a
=
new
Url
.
URL
(
"
/
"
,
mm
);
// Output 'http://username:password@host:8080/';
let
b
=
new
Url
.
URL
(
mm
);
// Output 'http://username:password@host:8080/';
new
Url
.
URL
(
'
path/path1
'
,
b
);
// Output 'http://username:password@host:8080/path/path1';
let
c
=
new
Url
.
URL
(
'
/path/path1
'
,
b
);
// Output 'http
://username:password@host:8080/path/path1';
new
Url
.
URL
(
'
/path/path1
'
,
c
);
// Output 'http://username:password@host:8080/path/path1';
new
Url
.
URL
(
'
/path/path1
'
,
a
);
// Output 'http://username:password@host:8080/path/path1';
let
mm
=
'
http
s
://username:password@host:8080
'
;
let
a
=
new
Url
.
URL
(
"
/
"
,
mm
);
// Output 'http
s
://username:password@host:8080/';
let
b
=
new
Url
.
URL
(
mm
);
// Output 'http
s
://username:password@host:8080/';
new
Url
.
URL
(
'
path/path1
'
,
b
);
// Output 'http
s
://username:password@host:8080/path/path1';
let
c
=
new
Url
.
URL
(
'
/path/path1
'
,
b
);
// Output 'http
s://username:password@host:8080/path/path1';
new
Url
.
URL
(
'
/path/path1
'
,
c
);
// Output 'http
s
://username:password@host:8080/path/path1';
new
Url
.
URL
(
'
/path/path1
'
,
a
);
// Output 'http
s
://username:password@host:8080/path/path1';
new
Url
.
URL
(
'
/path/path1
'
,
"
https://www.exampleUrl/fr-FR/toto
"
);
// 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
...
...
@@ -439,19 +438,11 @@ URL静态成员函数。
| url | string | 是 | 入参对象。 |
| base | string
\|
URL | 否 | 入参字符串或者对象。
<br/>
- string:字符串
<br/>
- URL:字符串或对象 |
**错误码:**
以下错误码的详细介绍请参见
[
语言基础类库错误码
](
../errorcodes/errorcode-utils.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200002 | Invalid url string. |
**示例:**
```
js
let
mm
=
'
http://username:password@host:8080
'
;
Url
.
URL
.
parseURL
(
mm
);
// Output 'http://username:password@host:8080/';
let
mm
=
'
http
s
://username:password@host:8080
'
;
Url
.
URL
.
parseURL
(
mm
);
// Output 'http
s
://username:password@host:8080/';
```
### tostring
...
...
@@ -471,11 +462,10 @@ toString(): string
**示例:**
```
js
const
url
=
new
Url
.
URL
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
const
url
=
new
Url
.
URL
(
'
http
s
://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
url
.
toString
();
```
### toJSON
toJSON(): string
...
...
@@ -492,7 +482,7 @@ toJSON(): string
**示例:**
```
js
const
url
=
new
Url
.
URL
(
'
http://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
const
url
=
new
Url
.
URL
(
'
http
s
://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
url
.
toJSON
();
```
...
...
@@ -902,126 +892,4 @@ let params = new Url.URLSearchParams(url.search.slice(1));
params
.
append
(
'
fod
'
,
'
3
'
);
console
.
log
(
params
.
toString
());
```
## URL
### 属性
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Utils.Lang
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| hash | string | 是 | 是 | 获取和设置URL的片段部分。 |
| host | string | 是 | 是 | 获取和设置URL的主机部分。 |
| hostname | string | 是 | 是 | 获取和设置URL的主机名部分,不带端口。 |
| href | string | 是 | 是 | 获取和设置序列化的URL。 |
| origin | string | 是 | 否 | 获取URL源的只读序列化。 |
| password | string | 是 | 是 | 获取和设置URL的密码部分。 |
| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 |
| port | string | 是 | 是 | 获取和设置URL的端口部分。 |
| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 |
| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 |
| searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 |
| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
| username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
### constructor<sup>(deprecated)</sup>
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[parseURL<sup>9+</sup>](#parseurl9)替代。
constructor(url: string, base?: string | URL)
URL的构造函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 入参对象。 |
| base | string
\|
URL | 否 | 入参字符串或者对象。
<br/>
- string:字符串
<br/>
- URL:字符串或对象 |
**示例:**
```
js
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/toto
"
);
// 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/
```
### parseURL<sup>9+</sup>
static parseURL(url : string, base?: string | URL): URL
URL静态成员函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 入参对象。 |
| base | string
\|
URL | 否 | 入参字符串或者对象。
<br/>
- string:字符串
<br/>
- URL:字符串或对象 |
**示例:**
```
js
let
mm
=
'
https://username:password@host:8080
'
;
Url
.
URL
.
parseURL
(
mm
);
// Output 'https://username:password@host:8080/';
```
### tostring
toString(): string
将解析过后的URL转化为字符串。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 用于返回网址的字符串序列化。 |
**示例:**
```
js
const
url
=
new
Url
.
URL
(
'
https://username:password@host:8080/directory/file?query=pppppp#qwer=da
'
);
url
.
toString
();
```
### toJSON
toJSON(): string
将解析过后的URL转化为JSON字符串。
**系统能力:**
SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 用于返回网址的字符串序列化。 |
**示例:**
```
js
const
url
=
new
Url
.
URL
(
'
https://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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录