mirror of
https://github.com/openharmony/js_api_module.git
synced 2026-08-24 22:21:26 -04:00
lifansheng
@@ -1,145 +1,213 @@
|
||||
#### js_api_module
|
||||
####一、URL简介
|
||||
URL接口用于解析，构造，规范化和编码 URLs。 URL的构造函数创建新的URL对象。 以便对URL的已解析组成部分或对URL进行更改。
|
||||
# js_api_module子系统/组件
|
||||
|
||||
接口介绍
|
||||
- [简介](#简介)
|
||||
- [目录](#目录)
|
||||
- [说明](#说明)
|
||||
- [接口说明](#接口说明)
|
||||
- [使用说明](#使用说明)
|
||||
|
||||
1.new URL(url: string,base?:string|URL)
|
||||
- [相关仓](#相关仓)
|
||||
|
||||
创建并返回一个URL对象，该URL对象引用使用绝对URL字符串，相对URL字符串和基本URL字符串指定的URL。
|
||||
## 简介
|
||||
|
||||
2.tostring():string;
|
||||
URL接口用于解析，构造，规范化和编码 URLs。 URL的构造函数创建新的URL对象。 以便对URL的已解析组成部分或对URL进行更改。URLSearchParams 接口定义了一些实用的方法来处理 URL 的查询字符串。
|
||||
|
||||
该字符串化方法返回一个包含完整 URL 的 USVString。它的作用等同于只读的 URL.href。
|
||||
## 目录
|
||||
|
||||
3.toJSON():string;
|
||||
```
|
||||
base/compileruntime/js_api_module/
|
||||
├── Class:URL # URL类
|
||||
│ ├── new URL(input[, base]) # 创建URL对象
|
||||
│ ├── hash # hash属性
|
||||
│ ├── host # host属性
|
||||
│ ├── hostname # hostname属性
|
||||
│ ├── href # href属性
|
||||
│ ├── origin # origin属性
|
||||
│ ├── password # password属性
|
||||
│ ├── pathname # pathname属性
|
||||
│ ├── port # port属性
|
||||
│ ├── protocol # protocol属性
|
||||
│ ├── search # search属性
|
||||
│ ├── searchParams # searchParams属性
|
||||
│ ├── username # username属性
|
||||
│ ├── toString() # toString方法
|
||||
│ └── toJSON() # toJSON方法
|
||||
└─── Class: URLSearchParams # URLSearchParams类
|
||||
├── new URLSearchParams() # 创建URLSearchParams对象
|
||||
├── new URLSearchParams(string) # 创建URLSearchParams对象
|
||||
├── new URLSearchParams(obj) # 创建URLSearchParams对象
|
||||
├── new URLSearchParams(iterable) # 创建URLSearchParams对象
|
||||
├── append(name, value) # append方法
|
||||
├── delete(name) # delete方法
|
||||
├── entries() # entries方法
|
||||
├── forEach(fn[, thisArg]) # forEach方法
|
||||
├── get(name) # get方法
|
||||
├── getAll(name) # getAll方法
|
||||
├── has(name) # has方法
|
||||
├── keys() # keys方法
|
||||
├── set(name, value) # set方法
|
||||
├── sort() # sort方法
|
||||
├── toString() # toString方法
|
||||
├── values() # values方法
|
||||
└── urlSearchParams[Symbol.iterator]() # 创建URLSearchParams对象
|
||||
```
|
||||
|
||||
该方法返回一个USVString，其中包含一个序列化的URL版本。
|
||||
## 说明
|
||||
|
||||
### 接口说明
|
||||
|
||||
|
||||
| 接口名 | 说明 |
|
||||
| -------- | -------- |
|
||||
| new URL(url: string,base?:string I URL) | 创建并返回一个URL对象，该URL对象引用使用绝对URL字符串，相对URL字符串和基本URL字符串指定的URL。 |
|
||||
| tostring():string | 该字符串化方法返回一个包含完整 URL 的 USVString。它的作用等同于只读的 URL.href。 |
|
||||
| toJSON():string | 该方法返回一个USVString，其中包含一个序列化的URL版本。 |
|
||||
| new URLSearchParams() | URLSearchParams() 构造器无入参，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。 |
|
||||
| new URLSearchParams(string) | URLSearchParams(string) 构造器的入参为string数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。 |
|
||||
| new URLSearchParams(obj) | URLSearchParams(obj) 构造器的入参为obj数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。 |
|
||||
| new URLSearchParams(iterable) | URLSearchParams(iterable) 构造器的入参为iterable数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。 |
|
||||
| has(name: string): boolean | 检索searchParams对象中是否含有name。有则返回ture，否则返回false。 |
|
||||
| set(name: string, value string): void | 检索searchParams对象中是否含有key为name的键值对。没有的话则添加该键值对，有的话则修改对象中第一个key所对应的value，并删除键为name的其余键值对。 |
|
||||
| sort(): void | 根据键的Unicode代码点，对包含在此对象中的所有键/值对进行排序，并返回undefined。 |
|
||||
| toString(): string | 根据searchParams对象,返回适用在URL中的查询字符串。 |
|
||||
| keys(): iterableIterator<string> | 返回一个iterator，遍历器允许遍历对象中包含的所有key值。 |
|
||||
| values(): iterableIterator<string> | 返回一个iterator，遍历器允许遍历对象中包含的所有value值。 |
|
||||
| append(name: string, value: string): void | 在searchParams对象中插入name, value键值对。 |
|
||||
| delete(name: string): void | 遍历searchParams对象，查找所有的name,删除对应的键值对。 |
|
||||
| get(name: string): string | 检索searchParams对象中第一个name,返回name键对应的值。 |
|
||||
| getAll(name: string): string[] | 检索searchParams对象中所有name,返回name键对应的所有值。 |
|
||||
| entries(): iterableIterator<[string, string]> | 返回一个iterator，允许遍历searchParams对象中包含的所有键/值对。 |
|
||||
| forEach(): void | 通过回调函数来遍历URLSearchParams实例对象上的键值对。 |
|
||||
| urlSearchParams[Symbol.iterator] () | 返回查询字符串中每个名称-值对的ES6迭代器。迭代器的每个项都是一个JavaScript数组。 |
|
||||
|
||||
### 使用说明
|
||||
|
||||
各接口使用方法如下：
|
||||
|
||||
let b = new URL('https://developer.mozilla.org'); // => 'https://developer.mozilla.org/'
|
||||
|
||||
let a = new URL( 'sca/./path/path/../scasa/jjjjj', 'http://www.example.com');
|
||||
// => 'http://www.example.com/sca/path/scasa/jjjjj'
|
||||
1、new URL(url: string,base?:string|URL)
|
||||
```
|
||||
let b = new URL('https://developer.mozilla.org'); // => 'https://developer.mozilla.org/'
|
||||
|
||||
let a = new URL( 'sca/./path/path/../scasa/text', 'http://www.example.com');
|
||||
// => 'http://www.example.com/sca/path/scasa/text'
|
||||
```
|
||||
2、tostring():string
|
||||
```
|
||||
const url = new URL('http://10.0xFF.O400.235:8080/directory/file?query#fragment');
|
||||
url.toString() // => 'http://10.0xff.o400.235:8080/directory/file?query#fragment'
|
||||
url.toString() // => 'http://10.0xff.o400.235:8080/directory/file?query#fragment'
|
||||
|
||||
const url = new URL("http://[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:80/index.html");
|
||||
url.toString() // => 'http://[fedc:ba98:7654:3210:fedc:ba98:7654:3210]/index.html'
|
||||
url.toString() // => 'http://[fedc:ba98:7654:3210:fedc:ba98:7654:3210]/index.html'
|
||||
|
||||
const url = new URL("http://username:password@host:8080/directory/file?query#fragment");
|
||||
url.toString() // => 'http://username:password@host:8080/directory/file?query#fragment'
|
||||
|
||||
url.toString() // => 'http://username:password@host:8080/directory/file?query#fragment'
|
||||
```
|
||||
3、toJSON():string
|
||||
```
|
||||
const url = new URL("https://developer.mozilla.org/en-US/docs/Web/API/URL/toString");
|
||||
url.toJSON(); // => 'https://developer.mozilla.org/en-US/docs/Web/API/URL/toString'
|
||||
|
||||
|
||||
####二、URLSreachParams简介
|
||||
|
||||
URLSearchParams 接口定义了一些实用的方法来处理 URL 的查询字符串。
|
||||
|
||||
接口介绍
|
||||
|
||||
1.new URLSearchParams()
|
||||
|
||||
URLSearchParams() 构造器无入参，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。
|
||||
|
||||
2.new URLSearchParams(string)
|
||||
|
||||
URLSearchParams(string) 构造器的入参为string数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。
|
||||
|
||||
3.new URLSearchParams(obj)
|
||||
|
||||
URLSearchParams(obj) 构造器的入参为obj数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。
|
||||
|
||||
4.new URLSearchParams(iterable)
|
||||
|
||||
URLSearchParams(iterable) 构造器的入参为iterable数据类型，该方法创建并返回一个新的URLSearchParams 对象。 开头的'?' 字符会被忽略。
|
||||
|
||||
5.isHas(name: string): boolean
|
||||
|
||||
检索searchParams对象中是否含有name。有则返回ture，否则返回false。
|
||||
|
||||
6.set(name: string, value string): void
|
||||
|
||||
检索searchParams对象中是否含有key为name的键值对。
|
||||
没有的话则添加该键值对，有的话则修改对象中第一个key所对应的value，并删除键为name的其余键值对。
|
||||
|
||||
7.sort(): void
|
||||
|
||||
根据键的Unicode代码点，对包含在此对象中的所有键/值对进行排序，并返回undefined。
|
||||
|
||||
8.toString(): string
|
||||
|
||||
根据searchParams对象,返回适用在URL中的查询字符串。
|
||||
|
||||
9.keys(): iterableIterator<string>
|
||||
|
||||
返回一个iterator，遍历器允许遍历对象中包含的所有key值。
|
||||
|
||||
10.values(): iterableIterator<string>
|
||||
|
||||
返回一个iterator，遍历器允许遍历对象中包含的所有value值。
|
||||
|
||||
11.append(name: string, value: string): void
|
||||
|
||||
在searchParams对象中插入name, value键值对。
|
||||
|
||||
12.delete(name: string): void
|
||||
|
||||
遍历searchParams对象，查找所有的name,删除对应的键值对。
|
||||
|
||||
13.get(name: string): string
|
||||
|
||||
检索searchParams对象中第一个name,返回name键对应的值。
|
||||
|
||||
14.getAll(name: string): string[]
|
||||
|
||||
检索searchParams对象中所有name,返回name键对应的所有值。
|
||||
|
||||
15.entries(): iterableIterator<[string, string]>
|
||||
|
||||
返回一个iterator，允许遍历searchParams对象中包含的所有键/值对。
|
||||
|
||||
16.forEach(): void
|
||||
通过回调函数来遍历URLSearchParams实例对象上的键值对.
|
||||
|
||||
各接口使用方法如下：
|
||||
|
||||
url.toJSON(); // => 'https://developer.mozilla.org/en-US/docs/Web/API/URL/toString'
|
||||
```
|
||||
4、new URLSearchParams()
|
||||
```
|
||||
let params = new URLSearchParams('foo=1&bar=2');
|
||||
```
|
||||
5、new URLSearchParams(string)
|
||||
```
|
||||
params = new URLSearchParams('user=abc&query=xyz');
|
||||
console.log(params.get('user'));
|
||||
// Prints 'abc'
|
||||
```
|
||||
6、new URLSearchParams(obj)
|
||||
```
|
||||
const params = new URLSearchParams({
|
||||
user: 'abc',
|
||||
query: ['first', 'second']
|
||||
});
|
||||
console.log(params.getAll('query'));
|
||||
// Prints [ 'first,second' ]
|
||||
```
|
||||
7、new URLSearchParams(iterable)
|
||||
```
|
||||
let params;
|
||||
|
||||
console.log(params.has('bar')); // =>ture
|
||||
|
||||
params.set('baz', 3);
|
||||
|
||||
params .sort();
|
||||
console.log(params .toString()); // =>bar=2&baz=3&foo=1'
|
||||
|
||||
// Using an array
|
||||
params = new URLSearchParams([
|
||||
['user', 'abc'],
|
||||
['query', 'first'],
|
||||
['query', 'second'],
|
||||
]);
|
||||
console.log(params.toString());
|
||||
// Prints 'user = abc & query = first&query = second'
|
||||
```
|
||||
8、has(name: string): boolean
|
||||
```
|
||||
console.log(params.has('bar')); // =>ture
|
||||
```
|
||||
9、set(name: string, value string): void
|
||||
```
|
||||
params.set('baz', 3);
|
||||
```
|
||||
10、sort(): void
|
||||
```
|
||||
params .sort();
|
||||
```
|
||||
11、toString(): string
|
||||
```
|
||||
console.log(params .toString()); // =>bar=2&baz=3&foo=1'
|
||||
```
|
||||
12、keys(): iterableIterator<string>
|
||||
```
|
||||
for(var key of params.keys()) {
|
||||
console.log(key);
|
||||
}
|
||||
// =>bar baz foo
|
||||
} // =>bar baz foo
|
||||
```
|
||||
13、values(): iterableIterator<string>
|
||||
```
|
||||
for(var value of params.values()) {
|
||||
console.log(value);
|
||||
} // =>2 3 1
|
||||
|
||||
params.append('foo', 3); // =>bar=2&baz=3&foo=1&foo=3
|
||||
|
||||
params.delete('baz'); // => bar=2&foo=1&foo=3
|
||||
|
||||
params.get('foo'); // => 1
|
||||
|
||||
params.getAll('foo'); // =>[ '1', '3' ]
|
||||
|
||||
for(var pair of searchParams.entries()) {
|
||||
console.log(pair[0]+ ', '+ pair[1]);
|
||||
} // => bar, 2 foo, 1 foo, 3
|
||||
|
||||
} // =>2 3 1
|
||||
```
|
||||
14、append(name: string, value: string): void
|
||||
```
|
||||
params.append('foo', 3); // =>bar=2&baz=3&foo=1&foo=3
|
||||
```
|
||||
15、delete(name: string): void
|
||||
```
|
||||
params.delete('baz'); // => bar=2&foo=1&foo=3
|
||||
```
|
||||
16、get(name: string): string
|
||||
```
|
||||
params.get('foo'); // => 1
|
||||
```
|
||||
17、getAll(name: string): string[]
|
||||
```
|
||||
params.getAll('foo'); // =>[ '1', '3' ]
|
||||
```
|
||||
18、entries(): iterableIterator<[string, string]>
|
||||
```
|
||||
for(var pair of searchParams.entries()) {
|
||||
console.log(pair[0]+ ', '+ pair[1]);
|
||||
} // => bar, 2 foo, 1 foo, 3
|
||||
```
|
||||
19、forEach(): void
|
||||
```
|
||||
url.searchParams.forEach((value, name, searchParams) => {
|
||||
console.log(name, value, url.searchParams === searchParams);
|
||||
});
|
||||
|
||||
// => foo 1 true
|
||||
// => bar 2 true
|
||||
```
|
||||
20、urlSearchParams[Symbol.iterator] ()
|
||||
```
|
||||
const params = new URLSearchParams('foo=bar&xyz=baz');
|
||||
for (const [name, value] of params) {
|
||||
console.log(name, value);
|
||||
}
|
||||
// Prints:
|
||||
// foo bar
|
||||
// xyz ba
|
||||
```
|
||||
## 相关仓
|
||||
[js_api_module子系统](https://gitee.com/OHOS_STD/js_api_module)
|
||||
|
||||
[base/compileruntime/js_api_module/](base/compileruntime/js_api_module-readme.md)
|
||||
|
||||
Reference in New Issue
Block a user