diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md
index df7bf37867a7410a18d2609db8255a90ce2d598e..530ffabede91e7a9b2dc1e89dfc915f04afd2067 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md
@@ -45,13 +45,13 @@ stat(path: string): Promise<Stat>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待获取文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待获取文件的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------- | ---------- |
| Promise<[Stat](#stat)> | 表示文件的具体信息。 |
- 示例:
@@ -73,10 +73,10 @@ stat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待获取文件的绝对路径。 |
- | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------- | ---- | --------------- |
+ | path | string | 是 | 待获取文件的绝对路径。 |
+ | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 |
- 示例:
```js
@@ -95,14 +95,14 @@ statSync(path:string): Stat
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待获取文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待获取文件的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 |
- 示例:
@@ -121,13 +121,13 @@ opendir(path: string): Promise<Dir>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件目录的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------- |
+ | path | string | 是 | 待打开文件目录的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | -------------------------- | -------- |
| Promise<[Dir](#dir)> | 返回Dir对象。 |
- 示例:
@@ -149,10 +149,10 @@ opendir(path: string, callback: AsyncCallback<Dir>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件目录的绝对路径。 |
- | callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------------------------------- | ---- | -------------- |
+ | path | string | 是 | 待打开文件目录的绝对路径。 |
+ | callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 |
- 示例:
```js
@@ -173,13 +173,13 @@ opendirSync(path: string): Dir
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件目录的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------- |
+ | path | string | 是 | 待打开文件目录的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ----------- | -------- |
| [Dir](#dir) | 返回Dir对象。 |
- 示例:
@@ -199,14 +199,14 @@ access(path: string, mode?: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:.
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待访问文件的绝对路径。 |
- | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待访问文件的绝对路径。 |
+ | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -228,11 +228,11 @@ access(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待访问文件的绝对路径。 |
- | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
- | callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待访问文件的绝对路径。 |
+ | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
+ | callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 |
- 示例:
```js
@@ -251,10 +251,10 @@ accessSync(path: string, mode?: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待访问文件的绝对路径。 |
- | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待访问文件的绝对路径。 |
+ | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
确认当前进程是否具有对应权限:
- 0:确认文件是否存在。
- 1:确认当前进程是否具有可执行权限。
- 2:确认当前进程是否具有写权限。
- 4:确认当前进程是否具有读权限。 |
- 示例:
```js
@@ -275,13 +275,13 @@ close(fd: number):Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待关闭文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待关闭文件的文件描述符。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -304,10 +304,10 @@ close(fd: number, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待关闭文件的文件描述符。 |
- | callback | AsyncCallback<void> | 是 | 异步关闭文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------ |
+ | fd | number | 是 | 待关闭文件的文件描述符。 |
+ | callback | AsyncCallback<void> | 是 | 异步关闭文件之后的回调。 |
- 示例:
```js
@@ -327,9 +327,9 @@ closeSync(fd: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待关闭文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待关闭文件的文件描述符。 |
- 示例:
```js
@@ -346,8 +346,8 @@ close(): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -369,9 +369,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------- |
+ | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 |
- 示例:
```js
@@ -390,15 +390,15 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
- | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
- | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | -------------------------- | ---- | ---------------------------------------- |
+ | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
+ | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
+ | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -420,12 +420,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
- | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
- | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
- | callback | AsyncCallback<void> | 是 | 异步复制文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------------------------- | ---- | ---------------------------------------- |
+ | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
+ | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
+ | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
+ | callback | AsyncCallback<void> | 是 | 异步复制文件之后的回调。 |
- 示例:
```js
@@ -444,11 +444,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
- | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
- | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | -------------------------- | ---- | ---------------------------------------- |
+ | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 |
+ | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 |
+ | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
- 示例:
```js
@@ -465,14 +465,14 @@ mkdir(path:string, mode?: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待创建目录的绝对路径。 |
- | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待创建目录的绝对路径。 |
+ | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -494,11 +494,11 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待创建目录的绝对路径。 |
- | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- | callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待创建目录的绝对路径。 |
+ | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 |
- 示例:
```js
@@ -519,10 +519,10 @@ mkdirSync(path: string, mode?: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待创建目录的绝对路径。 |
- | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待创建目录的绝对路径。 |
+ | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
- 0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 示例:
```js
@@ -539,15 +539,15 @@ open(path: string, flags?: number, mode?: number): Promise<number>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
- | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ----- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
+ | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | ----------- |
| Promise<number> | 打开文件的文件描述符。 |
- 示例:
@@ -569,12 +569,12 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | flags | number | 是 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
- | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- | callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | flags | number | 是 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
+ | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 |
- 示例:
```js
@@ -593,15 +593,15 @@ openSync(path:string, flags?:number, mode?:number): number
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
- | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ----- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
- 0o0:只读打开。
- 0o1:只写打开。
- 0o2:读写打开。
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
- 0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200:如果追加了0o100选项,且文件已经存在,则出错。
- 0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
- 0o2000:以追加方式打开,后续写将追加到文件末尾。
- 0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
- 0o200000:如果path指向目录,则出错。
- 0o400000:如果path指向符号链接,则出错。
- 0o4010000:以同步IO的方式打开文件。 |
+ | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
- 0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------ | ----------- |
| number | 打开文件的文件描述符。 |
- 示例:
@@ -623,15 +623,15 @@ read(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待读取文件的文件描述符。 |
- | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ----------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待读取文件的文件描述符。 |
+ | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------------- | ------ |
| Promise<[ReadOut](#readout)> | 读取的结果。 |
- 示例:
@@ -659,12 +659,12 @@ read(fd: number, buffer: ArrayBuffer, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待读取文件的文件描述符。 |
- | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步读取数据之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待读取文件的文件描述符。 |
+ | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步读取数据之后的回调。 |
- 示例:
```js
@@ -691,15 +691,15 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待读取文件的文件描述符。 |
- | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ----------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待读取文件的文件描述符。 |
+ | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------ | -------- |
| number | 实际读取的长度。 |
- 示例:
@@ -719,13 +719,13 @@ rmdir(path: string): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除目录的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待删除目录的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -747,10 +747,10 @@ rmdir(path: string, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除目录的绝对路径。 |
- | callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------ |
+ | path | string | 是 | 待删除目录的绝对路径。 |
+ | callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 |
- 示例:
```js
@@ -769,9 +769,9 @@ rmdirSync(path: string): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除目录的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待删除目录的绝对路径。 |
- 示例:
```js
@@ -788,13 +788,13 @@ unlink(path:string): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待删除文件的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -816,10 +816,10 @@ unlink(path:string, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除文件的绝对路径。 |
- | callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------ |
+ | path | string | 是 | 待删除文件的绝对路径。 |
+ | callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 |
- 示例:
```js
@@ -840,9 +840,9 @@ unlinkSync(path: string): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待删除文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待删除文件的绝对路径。 |
- 示例:
```js
@@ -864,15 +864,15 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待写入文件的文件描述符。 |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待写入文件的文件描述符。 |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | -------- |
| Promise<number> | 实际写入的长度。 |
- 示例:
@@ -900,12 +900,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待写入文件的文件描述符。 |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- | callback | AsyncCallback<number> | 是 | 异步将数据写入完成后执行的回调函数。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待写入文件的文件描述符。 |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | callback | AsyncCallback<number> | 是 | 异步将数据写入完成后执行的回调函数。 |
- 示例:
```js
@@ -932,15 +932,15 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待写入文件的文件描述符。 |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待写入文件的文件描述符。 |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------ | -------- |
| number | 实际写入的长度。 |
- 示例:
@@ -959,14 +959,14 @@ hash(path: string, algorithm: string): Promise<string>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待计算哈希值文件的绝对路径。 |
- | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | --------- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待计算哈希值文件的绝对路径。 |
+ | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | -------------------------- |
| Promise<string> | 文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
- 示例:
@@ -988,11 +988,11 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待计算哈希值文件的绝对路径。 |
- | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 |
- | callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | --------- | --------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待计算哈希值文件的绝对路径。 |
+ | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 |
+ | callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。 |
- 示例:
```js
@@ -1013,14 +1013,14 @@ chmod(path: string, mode: number):Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件权限的绝对路径。 |
- | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待改变文件权限的绝对路径。 |
+ | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -1042,11 +1042,11 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件权限的绝对路径。 |
- | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- | callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待改变文件权限的绝对路径。 |
+ | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 |
- 示例:
```js
@@ -1065,10 +1065,10 @@ chmodSync(path: string, mode: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件权限的绝对路径。 |
- | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待改变文件权限的绝对路径。 |
+ | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 示例:
```js
@@ -1085,13 +1085,13 @@ fstat(fd: number): Promise<Stat>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待获取文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待获取文件的文件描述符。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------- | ---------- |
| Promise<[Stat](#stat)> | 表示文件的具体信息。 |
- 示例:
@@ -1113,10 +1113,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待获取文件的文件描述符。 |
- | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件状态信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------- | ---- | ---------------- |
+ | fd | number | 是 | 待获取文件的文件描述符。 |
+ | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件状态信息之后的回调。 |
- 示例:
```js
@@ -1136,13 +1136,13 @@ fstatSync(fd: number): Stat
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待获取文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待获取文件的文件描述符。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 |
- 示例:
@@ -1161,14 +1161,14 @@ ftruncate(fd: number, len?: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待截断文件的文件描述符。 |
- | len | number | 是 | 文件截断后的长度,以字节为单位。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------- |
+ | fd | number | 是 | 待截断文件的文件描述符。 |
+ | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -1191,11 +1191,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待截断文件的文件描述符。 |
- | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------- |
+ | fd | number | 是 | 待截断文件的文件描述符。 |
+ | len | number | 是 | 文件截断后的长度,以字节为单位。 |
+ | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 |
- 示例:
```js
@@ -1214,10 +1214,10 @@ ftruncateSync(fd: number, len?: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待截断文件的文件描述符。 |
- | len | number | 否 | 文件截断后的长度,以字节为单位。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------- |
+ | fd | number | 是 | 待截断文件的文件描述符。 |
+ | len | number | 否 | 文件截断后的长度,以字节为单位。 |
- 示例:
```js
@@ -1234,14 +1234,14 @@ truncate(path: string, len?: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待截断文件的绝对路径。 |
- | len | number | 是 | 文件截断后的长度,以字节为单位。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------- |
+ | path | string | 是 | 待截断文件的绝对路径。 |
+ | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -1263,11 +1263,11 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待截断文件的绝对路径。 |
- | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------- |
+ | path | string | 是 | 待截断文件的绝对路径。 |
+ | len | number | 是 | 文件截断后的长度,以字节为单位。 |
+ | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 |
- 示例:
```js
@@ -1286,10 +1286,10 @@ truncateSync(path: string, len?: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待截断文件的绝对路径。 |
- | len | number | 否 | 文件截断后的长度,以字节为单位。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------- |
+ | path | string | 是 | 待截断文件的绝对路径。 |
+ | len | number | 否 | 文件截断后的长度,以字节为单位。 |
- 示例:
```js
@@ -1310,14 +1310,14 @@ readText(filePath: string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | filePath | string | 是 | 待读取文件的绝对路径。 |
- | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------ | ---- | ---------------------------------------- |
+ | filePath | string | 是 | 待读取文件的绝对路径。 |
+ | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | ---------- |
| Promise<string> | 返回读取文件的内容。 |
- 示例:
@@ -1343,11 +1343,11 @@ readText(filePath: string, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | filePath | string | 是 | 待读取文件的绝对路径。 |
- | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
- | callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | --------------------------- | ---- | ---------------------------------------- |
+ | filePath | string | 是 | 待读取文件的绝对路径。 |
+ | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
+ | callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 |
- 示例:
```js
@@ -1370,14 +1370,14 @@ readTextSync(filePath: string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | filePath | string | 是 | 待读取文件的绝对路径。 |
- | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------ | ---- | ---------------------------------------- |
+ | filePath | string | 是 | 待读取文件的绝对路径。 |
+ | options | Object | 否 | 支持如下选项:
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- encoding,string类型,当数据是 string 类型时有效,表示数据的编码方式,默认 'utf-8',仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | ---------- |
| Promise<string> | 返回读取文件的内容。 |
- 示例:
@@ -1395,13 +1395,13 @@ lstat(path: string): Promise<Stat>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------------- |
+ | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------- | ---------- |
| Promise<[Stat](#stat)> | 表示文件的具体信息。 |
- 示例:
@@ -1423,10 +1423,10 @@ lstat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
- | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------- | ---- | ----------------- |
+ | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
+ | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 |
- 示例:
```js
@@ -1445,13 +1445,13 @@ lstatSync(path:string): Stat
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------------- |
+ | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 |
- 示例:
@@ -1473,14 +1473,14 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ----------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------------- | ------ |
| Promise<[ReadOut](#readout)> | 读取的结果。 |
- 示例:
@@ -1506,11 +1506,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
- | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从文件读取数据之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
+ | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从文件读取数据之后的回调。 |
- 示例
```js
@@ -1532,14 +1532,14 @@ rename(oldPath: string, newPath: string): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | oldPath | string | 是 | 目标文件的当前绝对路径。 |
- | Newpath | String | 是 | 目标文件的新绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------ | ---- | ------------ |
+ | oldPath | string | 是 | 目标文件的当前绝对路径。 |
+ | Newpath | String | 是 | 目标文件的新绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -1561,11 +1561,11 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | oldpath | string | 是 | 目标文件的当前绝对路径。 |
- | Newpath | String | 是 | 目标文件的新绝对路径。 |
- | Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------- |
+ | oldpath | string | 是 | 目标文件的当前绝对路径。 |
+ | Newpath | String | 是 | 目标文件的新绝对路径。 |
+ | Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 |
- 示例:
```js
@@ -1583,10 +1583,10 @@ renameSync(oldPath: string, newPath: string): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | oldPath | string | 是 | 目标文件的当前绝对路径。 |
- | Newpath | String | 是 | 目标文件的新绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------ | ---- | ------------ |
+ | oldPath | string | 是 | 目标文件的当前绝对路径。 |
+ | Newpath | String | 是 | 目标文件的新绝对路径。 |
- 示例:
```js
@@ -1603,13 +1603,13 @@ fsync(fd: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -1631,10 +1631,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
- | Callback | AsyncCallback<void> | 是 | 异步将文件数据同步之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | --------------- |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
+ | Callback | AsyncCallback<void> | 是 | 异步将文件数据同步之后的回调。 |
- 示例:
```js
@@ -1653,9 +1653,9 @@ fsyncSync(fd: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
- 示例:
```js
@@ -1672,13 +1672,13 @@ fdatasync(fd: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例:
@@ -1700,10 +1700,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
- | callback | AsyncCallback <void> | 是 | 异步将文件内容数据同步之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------------- | ---- | ----------------- |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
+ | callback | AsyncCallback <void> | 是 | 异步将文件内容数据同步之后的回调。 |
- 示例:
```js
@@ -1722,9 +1722,9 @@ fdatasyncSync(fd: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待同步文件的文件描述符。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
- 示例:
```js
@@ -1741,14 +1741,14 @@ symlink(target: string, srcPath: string): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | target | string | 是 | 目标文件的绝对路径。 |
- | srcPath | string | 是 | 符号链接文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------ | ---- | ------------ |
+ | target | string | 是 | 目标文件的绝对路径。 |
+ | srcPath | string | 是 | 符号链接文件的绝对路径。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例:
@@ -1770,11 +1770,11 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | target | string | 是 | 目标文件的绝对路径。 |
- | srcPath | string | 是 | 符号链接文件的绝对路径。 |
- | callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------- |
+ | target | string | 是 | 目标文件的绝对路径。 |
+ | srcPath | string | 是 | 符号链接文件的绝对路径。 |
+ | callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 |
- 示例:
```js
@@ -1793,10 +1793,10 @@ symlinkSync(target: string, srcPath: string): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | target | string | 是 | 目标文件的绝对路径。 |
- | srcPath | string | 是 | 符号链接文件的绝对路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------ | ---- | ------------ |
+ | target | string | 是 | 目标文件的绝对路径。 |
+ | srcPath | string | 是 | 符号链接文件的绝对路径。 |
- 示例:
```js
@@ -1813,15 +1813,15 @@ chown(path: string, uid: number, gid: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件的绝对路径。 |
- | uid | number | 是 | 新的UID(UserID)。 |
- | gid | number | 是 | 新的GID(GroupID)。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | --------------- |
+ | path | string | 是 | 待改变文件的绝对路径。 |
+ | uid | number | 是 | 新的UID(UserID)。 |
+ | gid | number | 是 | 新的GID(GroupID)。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例:
@@ -1844,12 +1844,12 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件的绝对路径。 |
- | uid | number | 是 | 新的UID。 |
- | gid | number | 是 | 新的GID。 |
- | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | --------------- |
+ | path | string | 是 | 待改变文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
+ | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
- 示例:
```js
@@ -1869,11 +1869,11 @@ chownSync(path: string, uid: number, gid: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待改变文件的绝对路径。 |
- | uid | number | 是 | 新的UID。 |
- | gid | number | 是 | 新的GID。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待改变文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
- 示例:
```js
@@ -1891,13 +1891,13 @@ mkdtemp(prefix: string): Promise<string>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------ | ------ | ---- | --------------------------- |
+ | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | --------------------- | ---------- |
| Promise<string> | 生成的唯一目录路径。 |
- 示例:
@@ -1919,10 +1919,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
- | callback | AsyncCallback<string> | 是 | 异步创建临时目录之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | --------------------------- | ---- | --------------------------- |
+ | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
+ | callback | AsyncCallback<string> | 是 | 异步创建临时目录之后的回调。 |
- 示例:
```js
@@ -1941,13 +1941,13 @@ mkdtempSync(prefix: string): string
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------ | ------ | ---- | --------------------------- |
+ | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | ------ | ---------- |
| string | 产生的唯一目录路径。 |
- 示例:
@@ -1965,14 +1965,14 @@ fchmod(fd: number, mode: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例:
@@ -1994,11 +1994,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- | callback | AsyncCallback <void> | 是 | 异步改变文件权限之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | callback | AsyncCallback <void> | 是 | 异步改变文件权限之后的回调。 |
- 示例:
```js
@@ -2017,10 +2017,10 @@ fchmodSync(fd: number, mode: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
- 0o700:所有者具有读、写及可执行权限。
- 0o400:所有者具有读权限。
- 0o200:所有者具有写权限。
- 0o100:所有者具有可执行权限。
- 0o070:所有用户组具有读、写及可执行权限。
- 0o040:所有用户组具有读权限。
- 0o020:所有用户组具有写权限。
- 0o010:所有用户组具有可执行权限。
- 0o007:其余用户具有读、写及可执行权限。
- 0o004:其余用户具有读权限。
- 0o002:其余用户具有写权限。
- 0o001:其余用户具有可执行权限。 |
- 示例:
```js
@@ -2037,14 +2037,14 @@ createStream(path: string, mode: string): Promise<Stream>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------------------- | --------- |
| Promise<[Stream](#stream7)> | 返回文件流的结果。 |
- 示例:
@@ -2066,11 +2066,11 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>):
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- | callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | --------------------------------------- | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 |
- 示例:
```js
@@ -2089,14 +2089,14 @@ createStreamSync(path: string, mode: string): Stream
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 |
- 示例:
@@ -2114,14 +2114,14 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待打开文件的文件描述符。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待打开文件的文件描述符。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | --------------------------------- | --------- |
| Promise<[Stream](#stream7)> | 返回文件流的结果。 |
- 示例:
@@ -2143,11 +2143,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待打开文件的文件描述符。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- | callback | AsyncCallback <[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待打开文件的文件描述符。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | callback | AsyncCallback <[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 |
- 示例:
```js
@@ -2166,14 +2166,14 @@ fdopenStreamSync(fd: number, mode: string): Stream
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待打开文件的文件描述符。 |
- | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ---------------------------------------- |
+ | fd | number | 是 | 待打开文件的文件描述符。 |
+ | mode | string | 是 | - r:打开只读文件,该文件必须存在。
- r+:打开可读写的文件,该文件必须存在。
- w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
- a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
- a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 |
- 示例:
@@ -2191,15 +2191,15 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | uid | number | 是 | 文件所有者的UID。 |
- | gid | number | 是 | 文件所有组的GID。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | uid | number | 是 | 文件所有者的UID。 |
+ | gid | number | 是 | 文件所有组的GID。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -2222,12 +2222,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | uid | number | 是 | 文件所有者的UID。 |
- | gid | number | 是 | 文件所有组的GID。 |
- | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | --------------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | uid | number | 是 | 文件所有者的UID。 |
+ | gid | number | 是 | 文件所有组的GID。 |
+ | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
- 示例:
```js
@@ -2247,11 +2247,11 @@ fchownSync(fd: number, uid: number, gid: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fd | number | 是 | 待改变文件的文件描述符。 |
- | uid | number | 是 | 文件所有者的UID。 |
- | gid | number | 是 | 文件所有组的GID。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ------------ |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | uid | number | 是 | 文件所有者的UID。 |
+ | gid | number | 是 | 文件所有组的GID。 |
- 示例:
```js
@@ -2269,15 +2269,15 @@ lchown(path: string, uid: number, gid: number): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | uid | number | 是 | 新的UID。 |
- | gid | number | 是 | 新的GID。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ---------------------------- |
| Promise<void> | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例:
@@ -2300,12 +2300,12 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | uid | number | 是 | 新的UID。 |
- | gid | number | 是 | 新的GID。 |
- | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | --------------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
+ | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 |
- 示例:
```js
@@ -2325,11 +2325,11 @@ lchownSync(path: string, uid: number, gid: number): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | path | string | 是 | 待打开文件的绝对路径。 |
- | uid | number | 是 | 新的UID。 |
- | gid | number | 是 | 新的GID。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ---- | ------ | ---- | ----------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
- 示例:
```js
@@ -2347,15 +2347,15 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | filename | string | 是 | 待监视文件的绝对路径。 |
- | events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2:监听文件或者目录内容的是否修改。
- 3:两者都有。 |
- | callback | AsyncCallback<number > | 是 | 每发生变化一次,调用一次此函数。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | --------------------------------- | ---- | ---------------------------------------- |
+ | filename | string | 是 | 待监视文件的绝对路径。 |
+ | events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2:监听文件或者目录内容的是否修改。
- 3:两者都有。 |
+ | callback | AsyncCallback<number > | 是 | 每发生变化一次,调用一次此函数。 |
- 返回值:
- | 参数名 | 说明 |
- | -------- | -------- |
+ | 参数名 | 说明 |
+ | -------------------- | ---------- |
| [Watcher](#watcher7) | 文件变化监听的实例。 |
- 示例:
@@ -2372,11 +2372,11 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| bytesRead | number | 是 | 是 | 实际读取长度。 |
-| offset | number | 是 | 是 | 读取数据相对于缓冲区首地址的偏移。 |
-| buffer | ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| --------- | ---------- | ---- | ---- | ----------------- |
+| bytesRead | number | 是 | 是 | 实际读取长度。 |
+| offset | number | 是 | 是 | 读取数据相对于缓冲区首地址的偏移。 |
+| buffer | ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。 |
## Stat
@@ -2387,20 +2387,20 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
### 属性
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| dev | number | 是 | 否 | 标识包含该文件的主设备号。 |
-| ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 |
-| mode | number | 是 | 否 | 表示文件类型及权限,其首 4 位表示文件类型,后 12 位表示权限。各特征位的含义如下:
- 0o170000:可用于获取文件类型的掩码。
- 0o140000:文件是套接字。
- 0o120000:文件是符号链接。
- 0o100000:文件是一般文件。
- 0o060000:文件属于块设备。
- 0o040000:文件是目录。
- 0o020000:文件是字符设备。
- 0o010000:文件是具名管道,即FIFO。
- 0o0700:可用于获取用户权限的掩码。
- 0o0400:用户读,对于普通文件,所有者可读取文件;对于目录,所有者可读取目录项。
- 0o0200:用户写,对于普通文件,所有者可写入文件;对于目录,所有者可创建/删除目录项。
- 0o0100:用户执行,对于普通文件,所有者可执行文件;对于目录,所有者可在目录中搜索给定路径名。
- 0o0070:可用于获取用户组权限的掩码。
- 0o0040:用户组读,对于普通文件,所有用户组可读取文件;对于目录,所有用户组可读取目录项。
- 0o0020:用户组写,对于普通文件,所有用户组可写入文件;对于目录,所有用户组可创建/删除目录项。
- 0o0010:用户组执行,对于普通文件,所有用户组可执行文件;对于目录,所有用户组是否可在目录中搜索给定路径名。
- 0o0007:可用于获取其他用户权限的掩码。
- 0o0004:其他读,对于普通文件,其余用户可读取文件;对于目录,其他用户组可读取目录项。
- 0o0002:其他写,对于普通文件,其余用户可写入文件;对于目录,其他用户组可创建/删除目录项。
- 0o0001:其他执行,对于普通文件,其余用户可执行文件;对于目录,其他用户组可在目录中搜索给定路径名。 |
-| nlink | number | 是 | 否 | 文件的硬链接数。 |
-| uid | number | 是 | 否 | 文件所有者的ID。 |
-| gid | number | 是 | 否 | 文件所有组的ID。 |
-| rdev | number | 是 | 否 | 标识包含该文件的从设备号。 |
-| size | number | 是 | 否 | 文件的大小,以字节为单位。仅对普通文件有效。 |
-| blocks | number | 是 | 否 | 文件占用的块数,计算时块大小按512B计算。 |
-| atime | number | 是 | 否 | 上次访问该文件的时间,表示距1970年1月1日0时0分0秒的秒数。 |
-| mtime | number | 是 | 否 | 上次修改该文件的时间,表示距1970年1月1日0时0分0秒的秒数。 |
-| ctime | number | 是 | 否 | 最近改变文件状态的时间,表示距1970年1月1日0时0分0秒的秒数。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ------ | ------ | ---- | ---- | ---------------------------------------- |
+| dev | number | 是 | 否 | 标识包含该文件的主设备号。 |
+| ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 |
+| mode | number | 是 | 否 | 表示文件类型及权限,其首 4 位表示文件类型,后 12 位表示权限。各特征位的含义如下:
- 0o170000:可用于获取文件类型的掩码。
- 0o140000:文件是套接字。
- 0o120000:文件是符号链接。
- 0o100000:文件是一般文件。
- 0o060000:文件属于块设备。
- 0o040000:文件是目录。
- 0o020000:文件是字符设备。
- 0o010000:文件是具名管道,即FIFO。
- 0o0700:可用于获取用户权限的掩码。
- 0o0400:用户读,对于普通文件,所有者可读取文件;对于目录,所有者可读取目录项。
- 0o0200:用户写,对于普通文件,所有者可写入文件;对于目录,所有者可创建/删除目录项。
- 0o0100:用户执行,对于普通文件,所有者可执行文件;对于目录,所有者可在目录中搜索给定路径名。
- 0o0070:可用于获取用户组权限的掩码。
- 0o0040:用户组读,对于普通文件,所有用户组可读取文件;对于目录,所有用户组可读取目录项。
- 0o0020:用户组写,对于普通文件,所有用户组可写入文件;对于目录,所有用户组可创建/删除目录项。
- 0o0010:用户组执行,对于普通文件,所有用户组可执行文件;对于目录,所有用户组是否可在目录中搜索给定路径名。
- 0o0007:可用于获取其他用户权限的掩码。
- 0o0004:其他读,对于普通文件,其余用户可读取文件;对于目录,其他用户组可读取目录项。
- 0o0002:其他写,对于普通文件,其余用户可写入文件;对于目录,其他用户组可创建/删除目录项。
- 0o0001:其他执行,对于普通文件,其余用户可执行文件;对于目录,其他用户组可在目录中搜索给定路径名。 |
+| nlink | number | 是 | 否 | 文件的硬链接数。 |
+| uid | number | 是 | 否 | 文件所有者的ID。 |
+| gid | number | 是 | 否 | 文件所有组的ID。 |
+| rdev | number | 是 | 否 | 标识包含该文件的从设备号。 |
+| size | number | 是 | 否 | 文件的大小,以字节为单位。仅对普通文件有效。 |
+| blocks | number | 是 | 否 | 文件占用的块数,计算时块大小按512B计算。 |
+| atime | number | 是 | 否 | 上次访问该文件的时间,表示距1970年1月1日0时0分0秒的秒数。 |
+| mtime | number | 是 | 否 | 上次修改该文件的时间,表示距1970年1月1日0时0分0秒的秒数。 |
+| ctime | number | 是 | 否 | 最近改变文件状态的时间,表示距1970年1月1日0时0分0秒的秒数。 |
### isBlockDevice
@@ -2412,8 +2412,8 @@ isBlockDevice(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
- 示例:
@@ -2431,8 +2431,8 @@ isCharacterDevice(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
- 示例:
@@ -2450,8 +2450,8 @@ isDirectory(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
- 示例:
@@ -2469,8 +2469,8 @@ isFIFO(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------------- |
| boolean | 表示当前目录项是否是 FIFO。 |
- 示例:
@@ -2488,8 +2488,8 @@ isFile(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
- 示例:
@@ -2507,8 +2507,8 @@ isSocket(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
- 示例:
@@ -2526,8 +2526,8 @@ isSymbolicLink(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
- 示例:
@@ -2564,9 +2564,9 @@ stop(callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | 是 | 以异步方法关闭watcher监听之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ---------------------- |
+ | callback | AsyncCallback<void> | 是 | 以异步方法关闭watcher监听之后的回调。 |
- 示例:
```js
@@ -2590,8 +2590,8 @@ close(): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ------------- |
| Promise<void> | 表示异步关闭文件流的结果。 |
- 示例:
@@ -2614,9 +2614,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | ------------- |
+ | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 |
- 示例:
```js
@@ -2651,8 +2651,8 @@ flush(): Promise<void>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------------------- | ------------- |
| Promise<void> | 表示异步刷新文件流的结果。 |
- 示例:
@@ -2675,9 +2675,9 @@ flush(callback: AsyncCallback<void>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | 是 | 异步刷新文件流后的回调函数。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------- | ---- | -------------- |
+ | callback | AsyncCallback<void> | 是 | 异步刷新文件流后的回调函数。 |
- 示例:
```js
@@ -2717,14 +2717,14 @@ write(buffer: ArrayBuffer | string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------------------------------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | --------------------- | -------- |
| Promise<number> | 实际写入的长度。 |
- 示例:
@@ -2752,11 +2752,11 @@ write(buffer: ArrayBuffer | string, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- | callback | AsyncCallback<number> | 是 | 异步写入完成后执行的回调函数。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ------------------------------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | callback | AsyncCallback<number> | 是 | 异步写入完成后执行的回调函数。 |
- 示例:
```js
@@ -2784,14 +2784,14 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ------------------------------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
- length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
- encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认 'utf-8'。仅支持 'utf-8'。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------ | -------- |
| number | 实际写入的长度。 |
- 示例:
@@ -2814,14 +2814,14 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ----------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ---------------------------------- | ------ |
| Promise<[ReadOut](#readout)> | 读取的结果。 |
- 示例:
@@ -2848,11 +2848,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从流文件读取数据之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从流文件读取数据之后的回调。 |
- 示例:
```js
@@ -2878,14 +2878,14 @@ readSync(buffer: ArrayBuffer, options?: {
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
- | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | ------- | ----------- | ---- | ---------------------------------------- |
+ | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
+ | options | Object | 否 | 支持如下选项:
- offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
- length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
- position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------ | -------- |
| number | 实际读取的长度。 |
- 示例:
@@ -2909,8 +2909,8 @@ read(): Promise<Dirent>
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | -------------------------------- | ------------- |
| Promise<[Dirent](#dirent)> | 表示异步读取目录项的结果。 |
- 示例:
@@ -2933,9 +2933,9 @@ read(callback: AsyncCallback<Dirent>): void
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<[Dirent](#dirent)> | 是 | 异步读取下一个目录项之后的回调。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------------------------------------- | ---- | ---------------- |
+ | callback | AsyncCallback<[Dirent](#dirent)> | 是 | 异步读取下一个目录项之后的回调。 |
- 示例:
```js
@@ -2958,8 +2958,8 @@ readSync(): Dirent
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ----------------- | -------- |
| [Dirent](#dirent) | 表示一个目录项。 |
- 示例:
@@ -2992,9 +2992,9 @@ closeSync(): void
### 属性
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| name | string | 是 | 否 | 目录项的名称。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ---- | ------ | ---- | ---- | ------- |
+| name | string | 是 | 否 | 目录项的名称。 |
### isBlockDevice
@@ -3006,8 +3006,8 @@ isBlockDevice(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
- 示例:
@@ -3026,8 +3026,8 @@ isCharacterDevice(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
- 示例:
@@ -3046,8 +3046,8 @@ isDirectory(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
- 示例:
@@ -3066,8 +3066,8 @@ isFIFO(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 |
- 示例:
@@ -3086,8 +3086,8 @@ isFile(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
- 示例:
@@ -3106,8 +3106,8 @@ isSocket(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
- 示例:
@@ -3126,8 +3126,8 @@ isSymbolicLink(): boolean
**系统能力**:SystemCapability.FileManagement.File.FileIO
- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
+ | 类型 | 说明 |
+ | ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
- 示例:
diff --git a/zh-cn/application-dev/reference/apis/js-apis-i18n.md b/zh-cn/application-dev/reference/apis/js-apis-i18n.md
index 2ea09cf3a29dd5a30359fc112f19828c3147de24..8eebc8cccb5b0c5432225a68eba07a045405961f 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-i18n.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-i18n.md
@@ -2,7 +2,7 @@
>  **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
->
+>
> - I18N模块包含国际化能力增强接口(未在ECMA 402中定义)。
@@ -21,19 +21,19 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | language | string | 是 | 指定语言。 |
- | locale | string | 是 | 显示指定语言的区域ID。 |
- | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------------ | ------- | ---- | ---------------- |
+| language | string | 是 | 指定语言。 |
+| locale | string | 是 | 显示指定语言的区域ID。 |
+| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 指定语言的本地化显示文本。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------- |
+| string | 指定语言的本地化显示文本。 |
-- 示例:
+**示例:**
```
i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB");
@@ -48,19 +48,19 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | country | string | 是 | 指定国家。 |
- | locale | string | 是 | 显示指定国家的区域ID。 |
- | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------------ | ------- | ---- | ---------------- |
+| country | string | 是 | 指定国家。 |
+| locale | string | 是 | 显示指定国家的区域ID。 |
+| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 指定国家的本地化显示文本。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------- |
+| string | 指定国家的本地化显示文本。 |
-- 示例:
+**示例:**
```
i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB");
@@ -75,17 +75,17 @@ isRTL(locale: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 说明 |
- | -------- | -------- | -------- |
- | locale | string | 指定区域ID。 |
+**参数:**
+| 参数名 | 类型 | 说明 |
+| ------ | ------ | ------- |
+| locale | string | 指定区域ID。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | true表示该locale从右至左显示语言;false表示该locale从左至右显示语言。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | true表示该locale从右至左显示语言;false表示该locale从左至右显示语言。 |
-- 示例:
+**示例:**
```
i18n.isRTL("zh-CN");// 中文不是RTL语言,返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言,返回true
@@ -100,12 +100,12 @@ getSystemLanguage(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 系统语言ID。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------- |
+| string | 系统语言ID。 |
-- 示例:
+**示例:**
```
i18n.getSystemLanguage();
```
@@ -119,17 +119,17 @@ setSystemLanguage(language: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 说明 |
- | -------- | -------- | -------- |
- | language | string | 语言ID。 |
+**参数:**
+| 参数名 | 类型 | 说明 |
+| -------- | ------ | ----- |
+| language | string | 语言ID。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------------- |
+| boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 |
-- 示例:
+**示例:**
```
i18n.setSystemLanguage('zh');
```
@@ -137,18 +137,18 @@ setSystemLanguage(language: string): boolean
## i18n.getSystemLanguages
-getSystemLanguages(): Array
+getSystemLanguages(): Array<string>
获取系统支持的语言列表。
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | Array | 系统支持的语言ID列表。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------- | ------------ |
+| Array<string> | 系统支持的语言ID列表。 |
-- 示例:
+**示例:**
```
i18n.getSystemLanguages();
```
@@ -156,23 +156,23 @@ getSystemLanguages(): Array
## i18n.getSystemCountries
-getSystemCountries(language: string): Array
+getSystemCountries(language: string): Array<string>
获取针对输入语言系统支持的区域列表。
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 说明 |
- | -------- | -------- | -------- |
- | language | string | 语言ID。 |
+**参数:**
+| 参数名 | 类型 | 说明 |
+| -------- | ------ | ----- |
+| language | string | 语言ID。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | Array | 系统支持的区域ID列表。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------- | ------------ |
+| Array<string> | 系统支持的区域ID列表。 |
-- 示例:
+**示例:**
```
i18n.getSystemCountries('zh');
```
@@ -186,12 +186,12 @@ getSystemRegion(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 系统地区ID。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------- |
+| string | 系统地区ID。 |
-- 示例:
+**示例:**
```
i18n.getSystemRegion();
```
@@ -205,17 +205,17 @@ setSystemRegion(region: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 说明 |
- | -------- | -------- | -------- |
- | region | string | 地区ID。 |
+**参数:**
+| 参数名 | 类型 | 说明 |
+| ------ | ------ | ----- |
+| region | string | 地区ID。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------------- |
+| boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 |
-- 示例:
+**示例:**
```
i18n.setSystemRegion();
```
@@ -229,12 +229,12 @@ getSystemLocale(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 系统区域ID。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------- |
+| string | 系统区域ID。 |
-- 示例:
+**示例:**
```
i18n.getSystemLocale();
```
@@ -248,17 +248,17 @@ setSystemLocale(locale: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 说明 |
- | -------- | -------- | -------- |
- | locale | string | 指定区域ID,例如zh-CN。 |
+**参数:**
+| 参数名 | 类型 | 说明 |
+| ------ | ------ | --------------- |
+| locale | string | 指定区域ID,例如zh-CN。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示系统Locale设置成功;返回false,表示系统Locale设置失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true,表示系统Locale设置成功;返回false,表示系统Locale设置失败。 |
-- 示例:
+**示例:**
```
i18n.setSystemLocale('zh-CN');
```
@@ -272,18 +272,18 @@ isSuggested(language: string, region?: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | language | string | 是 | 合法的语言ID,例如zh。 |
- | region | string | 否 | 合法的地区ID,例如CN |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------ | ---- | ------------- |
+| language | string | 是 | 合法的语言ID,例如zh。 |
+| region | string | 否 | 合法的地区ID,例如CN |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 |
-- 示例:
+**示例:**
```
i18n.isSuggested('zh', 'CN');
```
@@ -297,18 +297,18 @@ getCalendar(locale: string, type? : string): Calendar
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 是 | 合法的locale值,例如zh-Hans-CN。 |
- | type | string | 否 | 合法的日历类型,目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时,采用区域默认的日历类型。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------------------- |
+| locale | string | 是 | 合法的locale值,例如zh-Hans-CN。 |
+| type | string | 否 | 合法的日历类型,目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时,采用区域默认的日历类型。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [Calendar](#calendar8) | 日历对象。 |
+**返回值:**
+| 类型 | 说明 |
+| ---------------------- | ----- |
+| [Calendar](#calendar8) | 日历对象。 |
-- 示例:
+**示例:**
```
i18n.getCalendar("zh-Hans", "gregory");
```
@@ -325,12 +325,12 @@ setTime(date: Date): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ---- | ---- | ----------------- |
+| date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
-- 示例:
+**示例:**
```
var calendar = I18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0);
@@ -346,12 +346,12 @@ setTime(time: number): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ---------------------------------------- |
+| time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 |
-- 示例:
+**示例:**
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);
@@ -366,17 +366,17 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | year | number | 是 | 设置的年。 |
- | month | number | 是 | 设置的月。 |
- | date | number | 是 | 设置的日。 |
- | hour | number | 否 | 设置的小时。 |
- | minute | number | 否 | 设置的分钟。 |
- | second | number | 否 | 设置的秒。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------ |
+| year | number | 是 | 设置的年。 |
+| month | number | 是 | 设置的月。 |
+| date | number | 是 | 设置的日。 |
+| hour | number | 否 | 设置的小时。 |
+| minute | number | 否 | 设置的分钟。 |
+| second | number | 否 | 设置的秒。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
@@ -391,12 +391,12 @@ setTimeZone(timezone: string): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------ | ---- | ------------------------- |
+| timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
@@ -411,12 +411,12 @@ getTimeZone(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 日历对象的时区id。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------- |
+| string | 日历对象的时区id。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
@@ -432,12 +432,12 @@ getFirstDayOfWeek(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 获取一周的起始日,1代表周日,7代表周六。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | --------------------- |
+| number | 获取一周的起始日,1代表周日,7代表周六。 |
-- 示例:
+**示例:**
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek();
@@ -452,12 +452,12 @@ setFirstDayOfWeek(value: number): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | --------------------- |
+| value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0);
@@ -472,12 +472,12 @@ getMinimalDaysInFirstWeek(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 一年中第一周的最小天数。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------ |
+| number | 一年中第一周的最小天数。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek();
@@ -492,12 +492,12 @@ setMinimalDaysInFirstWeek(value: number): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | value | number | 否 | 一年中第一周的最小天数。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | ------------ |
+| value | number | 否 | 一年中第一周的最小天数。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
@@ -512,17 +512,17 @@ get(field: string): number
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | field | string | 是 | 通过field来获取日历对象相应的值。目前支持的field值有 era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | ---------------------------------------- |
+| field | string | 是 | 通过field来获取日历对象相应的值。目前支持的field值有 era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
@@ -538,17 +538,17 @@ getDisplayName(locale: string): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 是 | locale指定获取哪个区域下该calendar的名字,如buddhist在en-US上显示的名称为“Buddhist Calendar”。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------------------- |
+| locale | string | 是 | locale指定获取哪个区域下该calendar的名字,如buddhist在en-US上显示的名称为“Buddhist Calendar”。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 日历在locale所指示的区域的名字。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------------- |
+| string | 日历在locale所指示的区域的名字。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // 佛历
@@ -563,17 +563,17 @@ isWeekend(date?: Date): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | date | Date | 否 | 判断日期在日历中是否是周末。如果date没有给出,判断calendar当前日期是否为周末。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ---- | ---- | ---------------------------------------- |
+| date | Date | 否 | 判断日期在日历中是否是周末。如果date没有给出,判断calendar当前日期是否为周末。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 当所判断的日期为周末时,返回 true,否则返回false。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ----------------------------------- |
+| boolean | 当所判断的日期为周末时,返回 true,否则返回false。 |
-- 示例:
+**示例:**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
@@ -595,12 +595,12 @@ constructor(country: string, options?: PhoneNumberFormatOptions)
**系统能力**:SystemCapability.Global.I18n
参数:
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| country | string | 是 | 表示电话号码所属国家或地区代码。 |
-| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ---------------------------------------- | ---- | ---------------- |
+| country | string | 是 | 表示电话号码所属国家或地区代码。 |
+| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 |
-- 示例:
+**示例:**
```
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
```
@@ -614,17 +614,17 @@ isValidNumber(number: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | number | string | 是 | 待判断的电话号码。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | --------- |
+| number | string | 是 | 待判断的电话号码。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------------- |
+| boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 |
-- 示例:
+**示例:**
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
@@ -639,17 +639,17 @@ format(number: string): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | number | string | 是 | 待格式化的电话号码。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| number | string | 是 | 待格式化的电话号码。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 格式化后的电话号码。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------- |
+| string | 格式化后的电话号码。 |
-- 示例:
+**示例:**
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312");
@@ -662,9 +662,9 @@ format(number: string): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164", "INTERNATIONAL", "NATIONAL", "RFC3966"。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ---- | ------ | ---- | ---- | ---------------------------------------- |
+| type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164", "INTERNATIONAL", "NATIONAL", "RFC3966"。 |
## UnitInfo8+
@@ -673,10 +673,10 @@ format(number: string): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| unit | string | 是 | 是 | 单位的名称,如:"meter", "inch", "cup"等。 |
-| measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI", "US", "UK"。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ------------- | ------ | ---- | ---- | ---------------------------------------- |
+| unit | string | 是 | 是 | 单位的名称,如:"meter", "inch", "cup"等。 |
+| measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI", "US", "UK"。 |
## Util8+
@@ -690,21 +690,21 @@ unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string,
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
- | toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
- | value | number | 是 | 要被转换的单位的数量值。 |
- | locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 |
- | style | string | 否 | 格式化使用的风格,取值包括:"long", "short", "medium"。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------- | ---- | ---------------------------------------- |
+| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
+| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
+| value | number | 是 | 要被转换的单位的数量值。 |
+| locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 |
+| style | string | 否 | 格式化使用的风格,取值包括:"long", "short", "medium"。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 按照toUnit的单位格式化后,得到的字符串。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------------------- |
+| string | 按照toUnit的单位格式化后,得到的字符串。 |
-- 示例:
+**示例:**
```
I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
```
@@ -718,17 +718,17 @@ getInstance(locale?:string): IndexUtil
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 否 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------- |
+| locale | string | 否 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------------ | --------------------- |
+| [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 |
-- 示例:
+**示例:**
```
var indexUtil= i18n.IndexUtil.getInstance("zh-CN");
```
@@ -745,12 +745,12 @@ getIndexList(): Array<string>
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | Array<string> | 返回当前locale对应的索引列表。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------- | ------------------ |
+| Array<string> | 返回当前locale对应的索引列表。 |
-- 示例:
+**示例:**
```
var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList();
@@ -765,12 +765,12 @@ addLocale(locale: string): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------- |
+| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
-- 示例:
+**示例:**
```
var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");
@@ -785,17 +785,17 @@ getIndex(text: string): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | text | string | 是 | 待计算索引值的输入文本。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ------------ |
+| text | string | 是 | 待计算索引值的输入文本。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 输入文本对应的索引值。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------- |
+| string | 输入文本对应的索引值。 |
-- 示例:
+**示例:**
```
var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // 返回h
@@ -813,17 +813,17 @@ isDigit(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------------ |
+| boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 |
-- 示例:
+**示例:**
```
var isdigit = Character.isDigit("1"); // 返回true
```
@@ -837,17 +837,17 @@ isSpaceChar(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | -------------------------------------- |
+| boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 |
-- 示例:
+**示例:**
```
var isspacechar = Character.isSpaceChar("a"); // 返回false
```
@@ -861,17 +861,17 @@ isWhitespace(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | -------------------------------------- |
+| boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 |
-- 示例:
+**示例:**
```
var iswhitespace = Character.isWhitespace("a"); // 返回false
```
@@ -885,17 +885,17 @@ isRTL(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 |
-- 示例:
+**示例:**
```
var isrtl = Character.isRTL("a"); // 返回false
```
@@ -909,17 +909,17 @@ isIdeograph(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 |
-- 示例:
+**示例:**
```
var isideograph = Character.isIdeograph("a"); // 返回false
```
@@ -933,17 +933,17 @@ isLetter(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------------ |
+| boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 |
-- 示例:
+**示例:**
```
var isletter = Character.isLetter("a"); // 返回true
```
@@ -957,17 +957,17 @@ isLowerCase(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 |
-- 示例:
+**示例:**
```
var islowercase = Character.isLowerCase("a"); // 返回true
```
@@ -981,17 +981,17 @@ isUpperCase(char: string): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 |
-- 示例:
+**示例:**
```
var isuppercase = Character.isUpperCase("a"); // 返回false
```
@@ -1005,17 +1005,17 @@ getType(char: string): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | char | string | 是 | 输入字符。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----- |
+| char | string | 是 | 输入字符。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 输入字符的一般类别值。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------- |
+| string | 输入字符的一般类别值。 |
-- 示例:
+**示例:**
```
var type = Character.getType("a");
```
@@ -1029,17 +1029,17 @@ getLineInstance(locale: string): BreakIterator
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 是 | 合法的locale值,例如zh-Hans-CN。生成的[BreakIterator](#breakiterator8)将按照locale所指定的区域的规则来进行断句。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------------------- |
+| locale | string | 是 | 合法的locale值,例如zh-Hans-CN。生成的[BreakIterator](#breakiterator8)将按照locale所指定的区域的规则来进行断句。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 |
+**返回值:**
+| 类型 | 说明 |
+| -------------------------------- | ----------- |
+| [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 |
-- 示例:
+**示例:**
```
i18n.getLineInstance("en");
```
@@ -1056,12 +1056,12 @@ setLineBreakText(text: string): void
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | text | string | 是 | 指定BreakIterator进行断句的文本。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ----------------------- |
+| text | string | 是 | 指定BreakIterator进行断句的文本。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1076,12 +1076,12 @@ getLineBreakText(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | BreakIterator对象正在处理的文本 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------- |
+| string | BreakIterator对象正在处理的文本 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1097,12 +1097,12 @@ current(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | BreakIterator在当前所处理的文本中的位置。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | --------------------------- |
+| number | BreakIterator在当前所处理的文本中的位置。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1118,12 +1118,12 @@ first(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 被处理文本的第一个分割点的偏移量。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------------- |
+| number | 被处理文本的第一个分割点的偏移量。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1139,12 +1139,12 @@ last(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 被处理的文本的最后一个分割点的偏移量 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------------ |
+| number | 被处理的文本的最后一个分割点的偏移量 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1160,17 +1160,17 @@ next(index?: number): number
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | index | number | 否 | [BreakIterator](#breakiterator8)将要移动的分割点数,正数代表向后移动,负数代表向前移动。若index没有给出,则按照index=1处理。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | ---------------------------------------- |
+| index | number | 否 | [BreakIterator](#breakiterator8)将要移动的分割点数,正数代表向后移动,负数代表向前移动。若index没有给出,则按照index=1处理。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 返回移动了index个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| number | 返回移动了index个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1188,12 +1188,12 @@ previous(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1211,17 +1211,17 @@ following(offset: number): number
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | offset | number | 是 | 将[BreakIterator](#breakiterator8)对象的位置设置到由offset所指定的位置的下一个分割点。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------------------------------- |
+| offset | number | 是 | 将[BreakIterator](#breakiterator8)对象的位置设置到由offset所指定的位置的下一个分割点。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 返回[BreakIterator](#breakiterator8)移动后的位置,如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| number | 返回[BreakIterator](#breakiterator8)移动后的位置,如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1239,17 +1239,17 @@ isBoundary(offset: number): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | offset | number | 是 | 指定需要进行判断的位置 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ----------- |
+| offset | number | 是 | 指定需要进行判断的位置 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 如果是一个分割点返回true, 否则返回false。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ------------------------------- |
+| boolean | 如果是一个分割点返回true, 否则返回false。 |
-- 示例:
+**示例:**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
@@ -1266,12 +1266,12 @@ is24HourClock(): boolean
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ---------------------------------------- |
+| boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 |
-- 示例:
+**示例:**
```
var is24HourClock = i18n.is24HourClock();
```
@@ -1285,17 +1285,17 @@ set24HourClock(option: boolean): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | option | boolean | 是 | option为true,表示开启系统24小时制开关;返回false,表示关闭系统24小时开关。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------- | ---- | ---------------------------------------- |
+| option | boolean | 是 | option为true,表示开启系统24小时制开关;返回false,表示关闭系统24小时开关。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示修改成功;返回false,表示修改失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ----------------------------- |
+| boolean | 返回true,表示修改成功;返回false,表示修改失败。 |
-- 示例:
+**示例:**
```
// 将系统时间设置为24小时制
var success = I18n.set24HourClock(true);
@@ -1310,18 +1310,18 @@ addPreferredLanguage(language: string, index?: number): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | language | string | 是 | 待添加的偏好语言。 |
- | index | number | 否 | 偏好语言的添加位置。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------ | ---- | ---------- |
+| language | string | 是 | 待添加的偏好语言。 |
+| index | number | 否 | 偏好语言的添加位置。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示添加成功;返回false,表示添加失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ----------------------------- |
+| boolean | 返回true,表示添加成功;返回false,表示添加失败。 |
-- 示例:
+**示例:**
```
// 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN';
@@ -1338,17 +1338,17 @@ removePreferredLanguage(index: number): boolean
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | --------------------- |
+| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | boolean | 返回true,表示删除成功;返回false,表示删除失败。 |
+**返回值:**
+| 类型 | 说明 |
+| ------- | ----------------------------- |
+| boolean | 返回true,表示删除成功;返回false,表示删除失败。 |
-- 示例:
+**示例:**
```
// 删除系统偏好语言列表中的第一个偏好语言
var index = 0;
@@ -1358,18 +1358,18 @@ removePreferredLanguage(index: number): boolean
## i18n.getPreferredLanguageList8+
-getPreferredLanguageList(): Array
+getPreferredLanguageList(): Array<string>
获取系统偏好语言列表。
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | Array | 系统偏好语言列表。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------- | --------- |
+| Array<string> | 系统偏好语言列表。 |
-- 示例:
+**示例:**
```
var preferredLanguageList = i18n.getPreferredLanguageList();
```
@@ -1383,12 +1383,12 @@ getFirstPreferredLanguage(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 偏好语言列表中的第一个语言。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | -------------- |
+| string | 偏好语言列表中的第一个语言。 |
-- 示例:
+**示例:**
```
var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
```
@@ -1402,17 +1402,17 @@ getTimeZone(zoneID?: string): TimeZone
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | zondID | string | 否 | 时区ID。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ----- |
+| zondID | string | 否 | 时区ID。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | TimeZone | 时区ID对应的时区对象。 |
+**返回值:**
+| 类型 | 说明 |
+| -------- | ------------ |
+| TimeZone | 时区ID对应的时区对象。 |
-- 示例:
+**示例:**
```
var timezone = i18n.getTimeZone();
```
@@ -1429,12 +1429,12 @@ getID(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 时区对象对应的时区ID。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------ |
+| string | 时区对象对应的时区ID。 |
-- 示例:
+**示例:**
```
var timezone = i18n.getTimeZone();
timezone.getID();
@@ -1449,18 +1449,18 @@ getDisplayName(locale?: string, isDST?: boolean): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 否 | 区域ID。 |
- | isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------- | ---- | -------------------- |
+| locale | string | 否 | 区域ID。 |
+| isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 时区对象在指定区域的表示。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------- |
+| string | 时区对象在指定区域的表示。 |
-- 示例:
+**示例:**
```
var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false);
@@ -1475,12 +1475,12 @@ getRawOffset(): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 时区对象表示的时区与UTC时区的偏差。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------------- |
+| number | 时区对象表示的时区与UTC时区的偏差。 |
-- 示例:
+**示例:**
```
var timezone = i18n.getTimeZone();
timezone.getRawOffset();
@@ -1495,12 +1495,12 @@ getOffset(date?: number): number
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------------------- |
+| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
-- 示例:
+**示例:**
```
var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890);
diff --git a/zh-cn/application-dev/reference/apis/js-apis-intl.md b/zh-cn/application-dev/reference/apis/js-apis-intl.md
index 9d4ea8f9485858d7c6338f0f222252a416512718..d34826f48d944d1f229bcea211dbdc4a16a2e813 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-intl.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-intl.md
@@ -2,7 +2,7 @@
>  **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
->
+>
> - Intl模块包含国际化能力基础接口(在ECMA 402中定义)。
@@ -20,18 +20,18 @@ import Intl from '@ohos.intl';
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| language | string | 是 | 否 | 与区域设置关联的语, 如:zh。 |
-| script | string | 是 | 否 | 语言的书写方式,如:Hans。 |
-| region | string | 是 | 否 | 与区域设置相关的地区,如:CN。 |
-| baseName | string | 是 | 否 | Locale的基本核心信息(由语言脚本与地区组成),如:zh-Hans-CN。 |
-| caseFirst | string | 是 | 否 | 区域的整理规则是否考虑大小写,取值包括:"upper", "lower", "false"。 |
-| calendar | string | 是 | 否 | 区域的日历信息,取值包括:"buddhist", "chinese", "coptic","dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
-| collation | string | 是 | 否 | 区域的排序规则,取值包括:"big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 |
-| hourCycle | string | 是 | 否 | 区域的时制信息,取值包括:"h12", "h23", "h11", "h24"。 |
-| numberingSystem | string | 是 | 否 | 区域使用的数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
-| numeric | boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| --------------- | ------- | ---- | ---- | ---------------------------------------- |
+| language | string | 是 | 否 | 与区域设置关联的语, 如:zh。 |
+| script | string | 是 | 否 | 语言的书写方式,如:Hans。 |
+| region | string | 是 | 否 | 与区域设置相关的地区,如:CN。 |
+| baseName | string | 是 | 否 | Locale的基本核心信息(由语言脚本与地区组成),如:zh-Hans-CN。 |
+| caseFirst | string | 是 | 否 | 区域的整理规则是否考虑大小写,取值包括:"upper", "lower", "false"。 |
+| calendar | string | 是 | 否 | 区域的日历信息,取值包括:"buddhist", "chinese", "coptic","dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
+| collation | string | 是 | 否 | 区域的排序规则,取值包括:"big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 |
+| hourCycle | string | 是 | 否 | 区域的时制信息,取值包括:"h12", "h23", "h11", "h24"。 |
+| numberingSystem | string | 是 | 否 | 区域使用的数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
+| numeric | boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。 |
### constructor8+
@@ -42,7 +42,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var locale = new Intl.Locale();
```
@@ -56,13 +56,13 @@ constructor(locale: string, options?: LocaleOptions)
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
- | options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ------------- | ---- | ---------------------------- |
+| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
-- 示例:
+**示例:**
```
var locale = new Intl.Locale("zh-CN");
```
@@ -76,12 +76,12 @@ toString(): string
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 字符串形式的区域信息。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ----------- |
+| string | 字符串形式的区域信息。 |
-- 示例:
+**示例:**
```
var locale = new Intl.Locale("zh-CN");
locale.toString();
@@ -96,12 +96,12 @@ maximize(): Locale
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [Locale](#locale) | 最大化后的区域对象。 |
+**返回值:**
+| 类型 | 说明 |
+| ----------------- | ---------- |
+| [Locale](#locale) | 最大化后的区域对象。 |
-- 示例:
+**示例:**
```
var locale = new Intl.Locale("zh-CN");
locale.maximize();
@@ -116,12 +116,12 @@ minimize(): Locale
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [Locale](#locale) | 最小化后的区域对象。 |
+**返回值:**
+| 类型 | 说明 |
+| ----------------- | ---------- |
+| [Locale](#locale) | 最小化后的区域对象。 |
-- 示例:
+**示例:**
```
var locale = new Intl.Locale("zh-CN");
locale.minimize();
@@ -134,14 +134,14 @@ minimize(): Locale
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| calendar | string | 是 | 是 | 日历参数,如:"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
-| collation | string | 是 | 是 | 排序参数,取值包括:"big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
-| hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11", "h12", "h23", "h24"。 |
-| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
-| numeric | boolean | 是 | 是 | 是否使用12小时制。 |
-| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序,取值范围:"upper", "lower", "false"。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| --------------- | ------- | ---- | ---- | ---------------------------------------- |
+| calendar | string | 是 | 是 | 日历参数,如:"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
+| collation | string | 是 | 是 | 排序参数,取值包括:"big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
+| hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11", "h12", "h23", "h24"。 |
+| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
+| numeric | boolean | 是 | 是 | 是否使用12小时制。 |
+| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序,取值范围:"upper", "lower", "false"。 |
## DateTimeFormat
@@ -155,7 +155,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var datefmt= new Intl.DateTimeFormat();
```
@@ -163,25 +163,25 @@ constructor()
### constructor
-constructor(locale: string | Array, options?: DateTimeOptions)
+constructor(locale: string | Array<string>, options?: DateTimeOptions)
创建时间日期格式化对象。
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string \| Array | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
- | options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ----------------------------------- | ---- | ---------------------------- |
+| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
-- 示例:
+**示例:**
```
var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
```
-- 示例:
+**示例:**
```
var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
```
@@ -195,17 +195,17 @@ format(date: Date): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | date | Date | 是 | 时间日期对象。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ---- | ---- | ------- |
+| date | Date | 是 | 时间日期对象。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 格式化后的时间日期字符串 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ------------ |
+| string | 格式化后的时间日期字符串 |
-- 示例:
+**示例:**
```
var date = new Date(2021, 11, 17, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB");
@@ -221,18 +221,18 @@ formatRange(startDate: Date, endDate: Date): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | startDate | Date | 是 | 起始的时间日期。 |
- | endDate | Date | 是 | 结束的时间日期。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| --------- | ---- | ---- | -------- |
+| startDate | Date | 是 | 起始的时间日期。 |
+| endDate | Date | 是 | 结束的时间日期。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 格式化后的时间日期段字符串。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | -------------- |
+| string | 格式化后的时间日期段字符串。 |
-- 示例:
+**示例:**
```
var startDate = new Date(2021, 11, 17, 3, 24, 0);
var endDate = new Date(2021, 11, 18, 3, 24, 0);
@@ -249,12 +249,12 @@ resolvedOptions(): DateTimeOptions
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [DateTimeOptions](#datetimeoptions) | DateTimeFormat 对象的格式化选项。 |
+**返回值:**
+| 类型 | 说明 |
+| ----------------------------------- | ----------------------------- |
+| [DateTimeOptions](#datetimeoptions) | DateTimeFormat 对象的格式化选项。 |
-- 示例:
+**示例:**
```
var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.resolvedOptions();
@@ -267,27 +267,27 @@ resolvedOptions(): DateTimeOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| locale | string | 是 | 否 | 区域参数, 如:zh-Hans-CN。 |
-| dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long", "short", "medium", "full"。 |
-| timeStyle | string | 是 | 是 | 时间显示格式,取值包括:"long", "short", "medium", "full"。 |
-| hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11", "h12", "h23", "h24"。 |
-| timeZone | string | 是 | 是 | 使用的时区(合法的IANA时区ID)。 |
-| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
-| hour12 | boolean | 是 | 是 | 是否使用12小时制。 |
-| weekday | string | 是 | 是 | 工作日的显示格式,取值包括:"long", "short", "narrow"。 |
-| era | string | 是 | 是 | 时代的显示格式,取值包括:"long", "short", "narrow"。 |
-| year | string | 是 | 是 | 年份的显示格式,取值包括:"numeric", "2-digit"。 |
-| month | string | 是 | 是 | 月份的显示格式,取值包括:"numeric", "2-digit", "long", "short", "narrow"。 |
-| day | string | 是 | 是 | 日期的显示格式,取值包括:"numeric", "2-digit"。 |
-| hour | string | 是 | 是 | 小时的显示格式,取值包括:"numeric", "2-digit"。 |
-| minute | string | 是 | 是 | 分钟的显示格式,取值包括:"numeric", "2-digit"。 |
-| second | string | 是 | 是 | 秒钟的显示格式,取值包括:"numeric", "2-digit"。 |
-| timeZoneName | string | 是 | 是 | 时区名称的本地化表示。 |
-| dayPeriod | string | 是 | 是 | 时段的显示格式,取值包括:"long", "short", "narrow"。 |
-| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法,取值包括:"lookup", "best fit"。 |
-| formatMatcher | string | 是 | 是 | 要使用的格式匹配算法,取值包括:"basic", "best fit"。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| --------------- | ------- | ---- | ---- | ---------------------------------------- |
+| locale | string | 是 | 否 | 区域参数, 如:zh-Hans-CN。 |
+| dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long", "short", "medium", "full"。 |
+| timeStyle | string | 是 | 是 | 时间显示格式,取值包括:"long", "short", "medium", "full"。 |
+| hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11", "h12", "h23", "h24"。 |
+| timeZone | string | 是 | 是 | 使用的时区(合法的IANA时区ID)。 |
+| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
+| hour12 | boolean | 是 | 是 | 是否使用12小时制。 |
+| weekday | string | 是 | 是 | 工作日的显示格式,取值包括:"long", "short", "narrow"。 |
+| era | string | 是 | 是 | 时代的显示格式,取值包括:"long", "short", "narrow"。 |
+| year | string | 是 | 是 | 年份的显示格式,取值包括:"numeric", "2-digit"。 |
+| month | string | 是 | 是 | 月份的显示格式,取值包括:"numeric", "2-digit", "long", "short", "narrow"。 |
+| day | string | 是 | 是 | 日期的显示格式,取值包括:"numeric", "2-digit"。 |
+| hour | string | 是 | 是 | 小时的显示格式,取值包括:"numeric", "2-digit"。 |
+| minute | string | 是 | 是 | 分钟的显示格式,取值包括:"numeric", "2-digit"。 |
+| second | string | 是 | 是 | 秒钟的显示格式,取值包括:"numeric", "2-digit"。 |
+| timeZoneName | string | 是 | 是 | 时区名称的本地化表示。 |
+| dayPeriod | string | 是 | 是 | 时段的显示格式,取值包括:"long", "short", "narrow"。 |
+| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法,取值包括:"lookup", "best fit"。 |
+| formatMatcher | string | 是 | 是 | 要使用的格式匹配算法,取值包括:"basic", "best fit"。 |
## NumberFormat
@@ -301,7 +301,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var numfmt = new Intl.NumberFormat();
```
@@ -309,19 +309,19 @@ constructor()
### constructor
-constructor(locale: string | Array, options?: NumberOptions)
+constructor(locale: string | Array<string>, options?: NumberOptions)
创建数字格式化对象。
**系统能力**:SystemCapability.Global.I18n
参数:
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| locale | string \| Array | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
-| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ------------------------------- | ---- | ---------------------------- |
+| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
-- 示例:
+**示例:**
```
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
```
@@ -335,18 +335,18 @@ format(number: number): string;
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | number | number | 是 | 数字对象 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---- |
+| number | number | 是 | 数字对象 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 格式化后的数字字符串 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------- |
+| string | 格式化后的数字字符串 |
-- 示例:
+**示例:**
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223);
@@ -361,13 +361,13 @@ resolvedOptions(): NumberOptions
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [NumberOptions](#numberoptions) | NumberFormat 对象的格式化选项。 |
+**返回值:**
+| 类型 | 说明 |
+| ------------------------------- | --------------------------- |
+| [NumberOptions](#numberoptions) | NumberFormat 对象的格式化选项。 |
-- 示例:
+**示例:**
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions();
@@ -380,27 +380,27 @@ resolvedOptions(): NumberOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| locale | string | 是 | 否 | 区域参数, 如:"zh-Hans-CN"。 |
-| currency | string | 是 | 是 | 货币单位, 如:"EUR","CNY","USD"等。 |
-| currencySign | string | 是 | 是 | 货币单位的符号显示,取值包括: "symbol","narrowSymbol","code","name" 。 |
-| currencyDisplay | string | 是 | 是 | 货币的显示方式,取值包括:"symbol", "narrowSymbol", "code", "name"。 |
-| unit | string | 是 | 是 | 单位名称,如:"meter","inch",“hectare”等。 |
-| unitDisplay | string | 是 | 是 | 单位的显示格式,取值包括:"long", "short", "medium"。 |
-| unitUsage | string | 是 | 是 | 单位的使用场景,取值包括:"default", "area-land-agricult", "area-land-commercl", "area-land-residntl", "length-person", "length-person-small", "length-rainfall", "length-road", "length-road-small", "length-snowfall", "length-vehicle", "length-visiblty", "length-visiblty-small", "length-person-informal", "length-person-small-informal", "length-road-informal", "speed-road-travel", "speed-wind", "temperature-person", "temperature-weather", "volume-vehicle-fuel"。 |
-| signDisplay | string | 是 | 是 | 数字符号的显示格式,取值包括:"auto", "never", "always", "expectZero"。 |
-| compactDisplay | string | 是 | 是 | 紧凑型的显示格式,取值包括:"long", "short"。 |
-| notation | string | 是 | 是 | 数字的格式化规格,取值包括:"standard", "scientific", "engineering", "compact"。 |
-| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法,取值包括:"lookup", "best fit"。 |
-| style | string | 是 | 是 | 数字的显示格式,取值包括:"decimal", "currency", "percent", "unit"。 |
-| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
-| useGrouping | boolean | 是 | 是 | 是否分组显示。 |
-| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 |
-| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数,取值范围:0~20。 |
-| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数,取值范围:1~21。 |
-| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数,取值范围:1~21。 |
-| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数,取值范围:1~21。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ------------------------ | ------- | ---- | ---- | ---------------------------------------- |
+| locale | string | 是 | 否 | 区域参数, 如:"zh-Hans-CN"。 |
+| currency | string | 是 | 是 | 货币单位, 如:"EUR","CNY","USD"等。 |
+| currencySign | string | 是 | 是 | 货币单位的符号显示,取值包括: "symbol","narrowSymbol","code","name" 。 |
+| currencyDisplay | string | 是 | 是 | 货币的显示方式,取值包括:"symbol", "narrowSymbol", "code", "name"。 |
+| unit | string | 是 | 是 | 单位名称,如:"meter","inch",“hectare”等。 |
+| unitDisplay | string | 是 | 是 | 单位的显示格式,取值包括:"long", "short", "medium"。 |
+| unitUsage | string | 是 | 是 | 单位的使用场景,取值包括:"default", "area-land-agricult", "area-land-commercl", "area-land-residntl", "length-person", "length-person-small", "length-rainfall", "length-road", "length-road-small", "length-snowfall", "length-vehicle", "length-visiblty", "length-visiblty-small", "length-person-informal", "length-person-small-informal", "length-road-informal", "speed-road-travel", "speed-wind", "temperature-person", "temperature-weather", "volume-vehicle-fuel"。 |
+| signDisplay | string | 是 | 是 | 数字符号的显示格式,取值包括:"auto", "never", "always", "expectZero"。 |
+| compactDisplay | string | 是 | 是 | 紧凑型的显示格式,取值包括:"long", "short"。 |
+| notation | string | 是 | 是 | 数字的格式化规格,取值包括:"standard", "scientific", "engineering", "compact"。 |
+| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法,取值包括:"lookup", "best fit"。 |
+| style | string | 是 | 是 | 数字的显示格式,取值包括:"decimal", "currency", "percent", "unit"。 |
+| numberingSystem | string | 是 | 是 | 数字系统,取值包括:"adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 |
+| useGrouping | boolean | 是 | 是 | 是否分组显示。 |
+| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 |
+| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数,取值范围:0~20。 |
+| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数,取值范围:1~21。 |
+| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数,取值范围:1~21。 |
+| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数,取值范围:1~21。 |
## Collator8+
@@ -414,7 +414,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var collator = new Intl.Collator();
```
@@ -422,20 +422,20 @@ constructor()
### constructor8+
-constructor(locale: string | Array, options?: CollatorOptions)
+constructor(locale: string | Array<string>, options?: CollatorOptions)
创建排序对象。
**系统能力**:SystemCapability.Global.I18n
-- 参数:
+**参数:**
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | locale | string \| Array | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
- | options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ----------------------------------- | ---- | ---------------------------- |
+| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 |
-- 示例:
+**示例:**
```
var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});
```
@@ -449,18 +449,18 @@ compare(first: string, second: string): number
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | first | string | 是 | 进行比较第一个字符串。 |
- | second | string | 是 | 进行比较的第二个字符串。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------------ |
+| first | string | 是 | 进行比较第一个字符串。 |
+| second | string | 是 | 进行比较的第二个字符串。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | number | 比较结果。当number为负数,表示first排序在second之前;当number为0,表示first与second排序相同;当number为正数,表示first排序在second之后。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| number | 比较结果。当number为负数,表示first排序在second之前;当number为0,表示first与second排序相同;当number为正数,表示first排序在second之后。 |
-- 示例:
+**示例:**
```
var collator = new Intl.Collator("zh-Hans");
collator.compare("first", "second");
@@ -475,12 +475,12 @@ resolvedOptions(): CollatorOptions
**系统能力**:SystemCapability.Global.I18n
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 |
+**返回值:**
+| 类型 | 说明 |
+| ----------------------------------- | ----------------- |
+| [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 |
-- 示例:
+**示例:**
```
var collator = new Intl.Collator("zh-Hans");
var options = collator.resolvedOptions();
@@ -493,15 +493,15 @@ resolvedOptions(): CollatorOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best fit", "lookup"。 |
-| usage | string | 是 | 是 | 比较的用途,取值范围:"sort", "search"。 |
-| sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值,取值范围:"base", "accent", "case", "variant"。 |
-| ignorePunctuation | boolean | 是 | 是 | 表示是否忽略标点符号,取值范围:true, false。 |
-| collation | string | 是 | 是 | 排序规则,取值范围:"big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 |
-| numeric | boolean | 是 | 是 | 是否使用数字排序,取值范围:true, false。 |
-| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序,取值范围:"upper", "lower", "false"。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
+| localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best fit", "lookup"。 |
+| usage | string | 是 | 是 | 比较的用途,取值范围:"sort", "search"。 |
+| sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值,取值范围:"base", "accent", "case", "variant"。 |
+| ignorePunctuation | boolean | 是 | 是 | 表示是否忽略标点符号,取值范围:true, false。 |
+| collation | string | 是 | 是 | 排序规则,取值范围:"big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 |
+| numeric | boolean | 是 | 是 | 是否使用数字排序,取值范围:true, false。 |
+| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序,取值范围:"upper", "lower", "false"。 |
## PluralRules8+
@@ -515,7 +515,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var pluralRules = new Intl.PluralRules();
```
@@ -523,19 +523,19 @@ constructor()
### constructor8+
-constructor(locale: string | Array, options?: PluralRulesOptions)
+constructor(locale: string | Array<string>, options?: PluralRulesOptions)
创建PluralRules对象。
**系统能力**:SystemCapability.Global.I18n
参数:
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| locale | string \| Array | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
-| options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ---------------------------------------- | ---- | ---------------------------- |
+| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 |
-- 示例:
+**示例:**
```
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
```
@@ -549,17 +549,17 @@ select(n: number): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | n | number | 是 | 待获取单复数类别的数字。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ---- | ------ | ---- | ------------ |
+| n | number | 是 | 待获取单复数类别的数字。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 单复数类别,取值包括:"zero","one","two", "few", "many", "others"。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------------------------------------- |
+| string | 单复数类别,取值包括:"zero","one","two", "few", "many", "others"。 |
-- 示例:
+**示例:**
```
var pluralRules = new Intl.PluralRules("zh-Hans");
pluralRules.select(1);
@@ -572,15 +572,15 @@ select(n: number): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best fit", "lookup"。 |
-| type | string | 是 | 是 | 排序的类型,取值包括:"cardinal", "ordinal"。 |
-| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 |
-| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数,取值范围:0~20。 |
-| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数,取值范围:1~21。 |
-| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数,取值范围:1~21。 |
-| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数,取值范围:1~21。 |
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
+| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best fit", "lookup"。 |
+| type | string | 是 | 是 | 排序的类型,取值包括:"cardinal", "ordinal"。 |
+| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 |
+| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数,取值范围:0~20。 |
+| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数,取值范围:1~21。 |
+| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数,取值范围:1~21。 |
+| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数,取值范围:1~21。 |
## RelativeTimeFormat8+
@@ -594,7 +594,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n
-- 示例:
+**示例:**
```
var relativetimefmt = new Intl.RelativeTimeFormat();
```
@@ -602,19 +602,19 @@ constructor()
### constructor8+
-constructor(locale: string | Array, options?: RelativeTimeFormatInputOptions)
+constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOptions)
创建相对时间格式化对象。
**系统能力**:SystemCapability.Global.I18n
参数:
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| locale | string \| Array | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
-| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ---------------------------------------- | ---- | ---------------------------- |
+| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
+| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 |
-- 示例:
+**示例:**
```
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
```
@@ -628,18 +628,18 @@ format(value: number, unit: string): string
**系统能力**:SystemCapability.Global.I18n
-- 参数:
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | value | number | 是 | 相对时间格式化的数值。 |
- | unit | string | 是 | 相对时间格式化的单位,取值包括:"year", "quarter", "month", "week", "day", "hour", "minute", "second"。 |
+**参数:**
+| 参数名 | 类型 | 必填 | 说明 |
+| ----- | ------ | ---- | ---------------------------------------- |
+| value | number | 是 | 相对时间格式化的数值。 |
+| unit | string | 是 | 相对时间格式化的单位,取值包括:"year", "quarter", "month", "week", "day", "hour", "minute", "second"。 |
-- 返回值:
- | 类型 | 说明 |
- | -------- | -------- |
- | string | 格式化后的相对时间。 |
+**返回值:**
+| 类型 | 说明 |
+| ------ | ---------- |
+| string | 格式化后的相对时间。 |
-- 示例:
+**示例:**
```
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter")
@@ -648,24 +648,24 @@ format(value: number, unit: string): string
### formatToParts8+
-formatToParts(value: number, unit: string): Array