@doubao-apps/create 0.0.30 → 0.0.31

package/dist/template-empty/references/reference/open-api/31-/346/226/207/344/273/266/347/263/273/347/273/237.md

@@ -0,0 +1,1043 @@
+# Open API: 文件系统
+
+文件读写、目录管理和文件信息操作。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getFileSystemManager](#getfilesystemmanager) | 获取文件系统管理器。 |
+
+## API 详情
+
+<a id="getfilesystemmanager"></a>
+### getFileSystemManager()
+
+> **getFileSystemManager**(): [`FileSystemManager`](#filesystemmanager)
+
+获取文件系统管理器
+
+#### Returns
+
+[`FileSystemManager`](#filesystemmanager)
+
+## 相关类型
+
+<a id="filesystemmanager"></a>
+<a id="access"></a>
+<a id="appendfile"></a>
+<a id="copyfile"></a>
+<a id="savefile"></a>
+<a id="getfileinfo"></a>
+<a id="getsavedfilelist"></a>
+<a id="mkdir"></a>
+<a id="readfile"></a>
+<a id="readdir"></a>
+<a id="removesavedfile"></a>
+<a id="rename"></a>
+<a id="rmdir"></a>
+<a id="stat"></a>
+<a id="truncate"></a>
+<a id="unlink"></a>
+<a id="unzip"></a>
+<a id="writefile"></a>
+### FileSystemManager
+
+文件系统管理器，提供对本地文件系统的完整读写能力。
+
+通过 [getFileSystemManager](#getfilesystemmanager) 获取实例后，可使用该接口上的方法执行文件和目录操作。
+大多数方法同时提供异步（返回 `Promise`）和同步（`Sync` 后缀）两种调用方式。
+
+#### Remarks
+
+- 所有路径参数均为本地文件路径，不支持网络路径。
+- 同步方法会阻塞当前 JS 线程直到操作完成；对于大文件操作建议使用异步方法以避免卡顿。
+- 文件操作失败时（如路径不存在、权限不足），Promise 会被 reject 或同步方法会抛出异常。
+
+#### Methods
+
+##### access()
+
+> **access**(`params`): `Promise`\<`void`\>
+
+判断文件或目录是否存在（异步）。
+
+路径存在时 Promise resolve；路径不存在时 Promise reject。
+
+###### Parameters
+
+• **params**: [`AccessParams`](#accessparams)
+
+参见 [AccessParams](#accessparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### accessSync()
+
+> **accessSync**(`params`): `void`
+
+判断文件或目录是否存在（同步）。
+
+路径不存在时会抛出异常。
+
+###### Parameters
+
+• **params**: [`AccessParams`](#accessparams)
+
+参见 [AccessParams](#accessparams)。
+
+###### Returns
+
+`void`
+
+##### appendFile()
+
+> **appendFile**(`params`): `Promise`\<`void`\>
+
+在文件末尾追加内容（异步）。如果文件不存在则创建。
+
+###### Parameters
+
+• **params**: [`AppendFileParams`](#appendfileparams)
+
+追加参数，参见 [AppendFileParams](#appendfileparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### appendFileSync()
+
+> **appendFileSync**(`params`): `void`
+
+在文件末尾追加内容（同步）。如果文件不存在则创建。
+
+###### Parameters
+
+• **params**: [`AppendFileParams`](#appendfileparams)
+
+追加参数，参见 [AppendFileParams](#appendfileparams)。
+
+###### Returns
+
+`void`
+
+##### copyFile()
+
+> **copyFile**(`params`): `Promise`\<`void`\>
+
+复制文件（异步）。不支持复制目录。
+
+###### Parameters
+
+• **params**: [`CopyFileParams`](#copyfileparams)
+
+参见 [CopyFileParams](#copyfileparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### copyFileSync()
+
+> **copyFileSync**(`params`): `void`
+
+复制文件（同步）。不支持复制目录。
+
+###### Parameters
+
+• **params**: [`CopyFileParams`](#copyfileparams)
+
+参见 [CopyFileParams](#copyfileparams)。
+
+###### Returns
+
+`void`
+
+##### getFileInfo()
+
+> **getFileInfo**(`params`): `Promise`\<[`GetFileInfoResult`](#getfileinforesult)\>
+
+获取文件信息，可选计算文件摘要（异步）。
+
+###### Parameters
+
+• **params**: [`GetFileInfoParams`](#getfileinfoparams)
+
+参见 [GetFileInfoParams](#getfileinfoparams)。
+
+###### Returns
+
+`Promise`\<[`GetFileInfoResult`](#getfileinforesult)\>
+
+返回一个 Promise，解析为 [GetFileInfoResult](#getfileinforesult)。
+
+##### getSavedFileList()
+
+> **getSavedFileList**(): `Promise`\<[`GetSavedFileListResult`](#getsavedfilelistresult)\>
+
+获取已保存的本地文件列表（异步）。
+
+###### Returns
+
+`Promise`\<[`GetSavedFileListResult`](#getsavedfilelistresult)\>
+
+返回一个 Promise，解析为 [GetSavedFileListResult](#getsavedfilelistresult)。
+
+##### mkdir()
+
+> **mkdir**(`params`): `Promise`\<`void`\>
+
+创建目录（异步）。
+
+###### Parameters
+
+• **params**: [`MkdirParams`](#mkdirparams)
+
+参见 [MkdirParams](#mkdirparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### mkdirSync()
+
+> **mkdirSync**(`params`): `void`
+
+创建目录（同步）。
+
+###### Parameters
+
+• **params**: [`MkdirParams`](#mkdirparams)
+
+参见 [MkdirParams](#mkdirparams)。
+
+###### Returns
+
+`void`
+
+##### readFile()
+
+> **readFile**(`params`): `Promise`\<[`ReadFileResult`](#readfileresult)\>
+
+读取文件内容（异步）。
+
+###### Parameters
+
+• **params**: [`ReadFileParams`](#readfileparams)
+
+读取参数，参见 [ReadFileParams](#readfileparams)。
+
+###### Returns
+
+`Promise`\<[`ReadFileResult`](#readfileresult)\>
+
+返回一个 Promise，解析为 [ReadFileResult](#readfileresult)。
+
+##### readFileSync()
+
+> **readFileSync**(`params`): [`ReadFileResult`](#readfileresult)
+
+读取文件内容（同步）。
+
+###### Parameters
+
+• **params**: [`ReadFileParams`](#readfileparams)
+
+读取参数，参见 [ReadFileParams](#readfileparams)。
+
+###### Returns
+
+[`ReadFileResult`](#readfileresult)
+
+返回 [ReadFileResult](#readfileresult)。
+
+##### readdir()
+
+> **readdir**(`params`): `Promise`\<[`ReaddirResult`](#readdirresult)\>
+
+读取目录下的文件和子目录列表（异步）。
+
+###### Parameters
+
+• **params**: [`ReaddirParams`](#readdirparams)
+
+参见 [ReaddirParams](#readdirparams)。
+
+###### Returns
+
+`Promise`\<[`ReaddirResult`](#readdirresult)\>
+
+返回一个 Promise，解析为 [ReaddirResult](#readdirresult)。
+
+##### readdirSync()
+
+> **readdirSync**(`params`): [`ReaddirResult`](#readdirresult)
+
+读取目录下的文件和子目录列表（同步）。
+
+###### Parameters
+
+• **params**: [`ReaddirParams`](#readdirparams)
+
+参见 [ReaddirParams](#readdirparams)。
+
+###### Returns
+
+[`ReaddirResult`](#readdirresult)
+
+返回 [ReaddirResult](#readdirresult)。
+
+##### removeSavedFile()
+
+> **removeSavedFile**(`params`): `Promise`\<`void`\>
+
+删除通过 [FileSystemManager.saveFile](#savefile) 保存的本地文件（异步）。
+
+###### Parameters
+
+• **params**: [`RemoveSavedFileParams`](#removesavedfileparams)
+
+参见 [RemoveSavedFileParams](#removesavedfileparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### rename()
+
+> **rename**(`params`): `Promise`\<`void`\>
+
+重命名或移动文件（异步）。
+
+###### Parameters
+
+• **params**: [`RenameParams`](#renameparams)
+
+参见 [RenameParams](#renameparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### renameSync()
+
+> **renameSync**(`params`): `void`
+
+重命名或移动文件（同步）。
+
+###### Parameters
+
+• **params**: [`RenameParams`](#renameparams)
+
+参见 [RenameParams](#renameparams)。
+
+###### Returns
+
+`void`
+
+##### rmdir()
+
+> **rmdir**(`params`): `Promise`\<`void`\>
+
+删除目录（异步）。
+
+###### Parameters
+
+• **params**: [`RmdirParams`](#rmdirparams)
+
+参见 [RmdirParams](#rmdirparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### rmdirSync()
+
+> **rmdirSync**(`params`): `void`
+
+删除目录（同步）。
+
+###### Parameters
+
+• **params**: [`RmdirParams`](#rmdirparams)
+
+参见 [RmdirParams](#rmdirparams)。
+
+###### Returns
+
+`void`
+
+##### saveFile()
+
+> **saveFile**(`params`): `Promise`\<[`SaveFileResult`](#savefileresult)\>
+
+将临时文件保存到本地持久化存储（异步）。
+
+###### Parameters
+
+• **params**: [`SaveFileParams`](#savefileparams)
+
+参见 [SaveFileParams](#savefileparams)。
+
+###### Returns
+
+`Promise`\<[`SaveFileResult`](#savefileresult)\>
+
+返回一个 Promise，解析为 [SaveFileResult](#savefileresult)。
+
+##### saveFileSync()
+
+> **saveFileSync**(`params`): [`SaveFileResult`](#savefileresult)
+
+将临时文件保存到本地持久化存储（同步）。
+
+###### Parameters
+
+• **params**: [`SaveFileParams`](#savefileparams)
+
+参见 [SaveFileParams](#savefileparams)。
+
+###### Returns
+
+[`SaveFileResult`](#savefileresult)
+
+返回 [SaveFileResult](#savefileresult)。
+
+##### stat()
+
+> **stat**(`params`): `Promise`\<[`StatResult`](#statresult)\>
+
+获取文件或目录的状态信息（异步）。
+
+###### Parameters
+
+• **params**: [`StatParams`](#statparams)
+
+参见 [StatParams](#statparams)。
+
+###### Returns
+
+`Promise`\<[`StatResult`](#statresult)\>
+
+返回一个 Promise，解析为 [StatResult](#statresult)。
+
+##### statSync()
+
+> **statSync**(`params`): [`StatResult`](#statresult)
+
+获取文件或目录的状态信息（同步）。
+
+###### Parameters
+
+• **params**: [`StatParams`](#statparams)
+
+参见 [StatParams](#statparams)。
+
+###### Returns
+
+[`StatResult`](#statresult)
+
+返回 [StatResult](#statresult)。
+
+##### truncate()
+
+> **truncate**(`params`): `Promise`\<`void`\>
+
+截断文件到指定长度（异步）。
+
+###### Parameters
+
+• **params**: [`TruncateParams`](#truncateparams)
+
+参见 [TruncateParams](#truncateparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### truncateSync()
+
+> **truncateSync**(`params`): `void`
+
+截断文件到指定长度（同步）。
+
+###### Parameters
+
+• **params**: [`TruncateParams`](#truncateparams)
+
+参见 [TruncateParams](#truncateparams)。
+
+###### Returns
+
+`void`
+
+##### unlink()
+
+> **unlink**(`params`): `Promise`\<`void`\>
+
+删除文件（异步）。不能用于删除目录。
+
+###### Parameters
+
+• **params**: [`UnlinkParams`](#unlinkparams)
+
+参见 [UnlinkParams](#unlinkparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### unlinkSync()
+
+> **unlinkSync**(`params`): `void`
+
+删除文件（同步）。不能用于删除目录。
+
+###### Parameters
+
+• **params**: [`UnlinkParams`](#unlinkparams)
+
+参见 [UnlinkParams](#unlinkparams)。
+
+###### Returns
+
+`void`
+
+##### unzip()
+
+> **unzip**(`params`): `Promise`\<`void`\>
+
+解压 zip 文件到指定目录（异步）。
+
+###### Parameters
+
+• **params**: [`UnzipParams`](#unzipparams)
+
+参见 [UnzipParams](#unzipparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### writeFile()
+
+> **writeFile**(`params`): `Promise`\<`void`\>
+
+写入文件内容（异步）。如果文件不存在则创建，已存在则覆盖。
+
+###### Parameters
+
+• **params**: [`WriteFileParams`](#writefileparams)
+
+写入参数，参见 [WriteFileParams](#writefileparams)。
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### writeFileSync()
+
+> **writeFileSync**(`params`): `void`
+
+写入文件内容（同步）。如果文件不存在则创建，已存在则覆盖。
+
+###### Parameters
+
+• **params**: [`WriteFileParams`](#writefileparams)
+
+写入参数，参见 [WriteFileParams](#writefileparams)。
+
+###### Returns
+
+`void`
+
+<a id="accessparams"></a>
+### AccessParams
+
+[FileSystemManager.access](#access) 的参数。
+
+#### Properties
+
+##### path
+
+> **path**: `string`
+
+要判断是否存在的文件或目录路径。
+
+<a id="appendfileparams"></a>
+### AppendFileParams
+
+[FileSystemManager.appendFile](#appendfile) 的参数。
+
+#### Remarks
+
+- 如果文件不存在会自动创建。
+- 与 [WriteFileParams](#writefileparams) 不同，追加写入不会覆盖文件已有内容，而是在末尾追加。
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+要追加的内容。
+
+- 当 `encoding` 为 `'utf-8'` 时，直接追加该字符串；
+- 当 `encoding` 为 `'base64'` 时，将该字符串先进行 Base64 解码再追加到文件末尾。
+
+##### encoding?
+
+> `optional` **encoding**: `"base64"` \| `"utf-8"`
+
+指定写入文件的字符编码。
+
+###### Default
+
+```ts
+'utf-8'
+```
+
+##### filePath
+
+> **filePath**: `string`
+
+要追加内容的文件路径（本地路径）。
+
+<a id="copyfileparams"></a>
+### CopyFileParams
+
+[FileSystemManager.copyFile](#copyfile) 的参数。
+
+#### Remarks
+
+- 不支持复制目录，仅支持复制文件。
+- 如果目标路径已存在同名文件，会被覆盖。
+
+#### Properties
+
+##### destPath
+
+> **destPath**: `string`
+
+目标文件路径（复制后生成的文件）。
+
+##### srcPath
+
+> **srcPath**: `string`
+
+源文件路径（被复制的文件）。
+
+<a id="getfileinfoparams"></a>
+<a id="digestalgorithm"></a>
+### GetFileInfoParams
+
+[FileSystemManager.getFileInfo](#getfileinfo) 的参数。
+
+#### Properties
+
+##### digestAlgorithm?
+
+> `optional` **digestAlgorithm**: `"md5"` \| `"sha1"`
+
+用于计算文件摘要的哈希算法。
+
+- `'md5'`：使用 MD5 算法计算文件摘要。
+- `'sha1'`：使用 SHA-1 算法计算文件摘要。
+
+不传时不计算摘要，返回结果中 [GetFileInfoResult.digest](#digest) 为 `undefined`。
+
+##### filePath
+
+> **filePath**: `string`
+
+要获取信息的文件路径。
+
+<a id="getfileinforesult"></a>
+<a id="digest"></a>
+### GetFileInfoResult
+
+[FileSystemManager.getFileInfo](#getfileinfo) 的返回结果。
+
+#### Properties
+
+##### digest?
+
+> `optional` **digest**: `string`
+
+按照 [GetFileInfoParams.digestAlgorithm](#digestalgorithm) 计算得到的文件摘要（十六进制字符串）。
+
+仅当请求时指定了 `digestAlgorithm` 才会返回。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位为字节（Byte）。
+
+<a id="getsavedfilelistresult"></a>
+### GetSavedFileListResult
+
+[FileSystemManager.getSavedFileList](#getsavedfilelist) 的返回结果。
+
+#### Properties
+
+##### fileList
+
+> **fileList**: `object`[]
+
+已保存的本地文件列表，每项包含文件路径、大小和创建时间。
+
+<a id="mkdirparams"></a>
+### MkdirParams
+
+[FileSystemManager.mkdir](#mkdir) 的参数。
+
+#### Properties
+
+##### dirPath
+
+> **dirPath**: `string`
+
+要创建的目录路径。
+
+##### recursive?
+
+> `optional` **recursive**: `boolean`
+
+是否递归创建该目录的上级目录。
+
+设为 `true` 时，即使中间路径不存在也会一并创建（类似 `mkdir -p`）。
+
+###### Default
+
+```ts
+false
+```
+
+<a id="readfileparams"></a>
+<a id="encoding-1"></a>
+### ReadFileParams
+
+[FileSystemManager.readFile](#readfile) 的参数。
+
+#### Properties
+
+##### encoding?
+
+> `optional` **encoding**: `"base64"` \| `"utf-8"`
+
+指定读取文件的字符编码。
+
+- `'utf-8'`：以 UTF-8 字符串形式返回文件内容。
+- `'base64'`：以 Base64 编码字符串形式返回文件内容，适用于二进制文件。
+
+###### Default
+
+```ts
+'utf-8'
+```
+
+##### filePath
+
+> **filePath**: `string`
+
+要读取的文件路径（本地路径）。
+
+<a id="readfileresult"></a>
+### ReadFileResult
+
+[FileSystemManager.readFile](#readfile) 的返回结果。
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+文件内容。
+
+具体格式由 [ReadFileParams.encoding](#encoding-1) 决定：
+- 编码为 `'utf-8'` 时返回 UTF-8 字符串；
+- 编码为 `'base64'` 时返回 Base64 编码后的字符串。
+
+<a id="readdirparams"></a>
+### ReaddirParams
+
+[FileSystemManager.readdir](#readdir) 的参数。
+
+#### Properties
+
+##### dirPath
+
+> **dirPath**: `string`
+
+要读取的目录路径。
+
+<a id="readdirresult"></a>
+### ReaddirResult
+
+[FileSystemManager.readdir](#readdir) 的返回结果。
+
+#### Properties
+
+##### files
+
+> **files**: `string`[]
+
+目录下的文件和子目录名称列表（不含 `.` 和 `..`）。
+
+<a id="removesavedfileparams"></a>
+### RemoveSavedFileParams
+
+[FileSystemManager.removeSavedFile](#removesavedfile) 的参数。
+
+#### Remarks
+
+- 该接口用于删除通过 [FileSystemManager.saveFile](#savefile) 保存的本地文件。
+- 对非已保存文件调用该接口可能会失败。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+需要删除的已保存文件路径（应为 [SaveFileResult.savedFilePath](#savedfilepath) 返回的路径）。
+
+<a id="renameparams"></a>
+### RenameParams
+
+[FileSystemManager.rename](#rename) 的参数。
+
+#### Remarks
+
+- 可用于重命名文件或将文件移动到同一文件系统中的其他路径。
+- 如果目标路径已存在同名文件，行为取决于宿主实现（通常会覆盖）。
+
+#### Properties
+
+##### newPath
+
+> **newPath**: `string`
+
+新文件路径（即重命名或移动后的目标路径）。
+
+##### oldPath
+
+> **oldPath**: `string`
+
+源文件路径（即当前文件路径）。
+
+<a id="rmdirparams"></a>
+### RmdirParams
+
+[FileSystemManager.rmdir](#rmdir) 的参数。
+
+#### Properties
+
+##### dirPath
+
+> **dirPath**: `string`
+
+要删除的目录路径。
+
+##### recursive?
+
+> `optional` **recursive**: `boolean`
+
+是否递归删除目录下的所有子文件和子目录。
+
+设为 `false` 时，仅当目录为空才能删除成功；设为 `true` 时会递归删除所有内容。
+
+###### Default
+
+```ts
+false
+```
+
+<a id="savefileparams"></a>
+### SaveFileParams
+
+[FileSystemManager.saveFile](#savefile) 的参数。
+
+#### Remarks
+
+- 该接口用于将临时文件保存到本地持久化存储。临时文件在应用退出后可能被系统清理，
+  通过 `saveFile` 保存后的文件将不会被自动清理。
+- 保存成功后原临时文件会被移除。
+
+#### Properties
+
+##### filePath?
+
+> `optional` **filePath**: `string`
+
+保存到的目标文件路径。
+
+若不指定，则由宿主决定存储位置并通过 [SaveFileResult.savedFilePath](#savedfilepath) 返回。
+
+##### tempFilePath
+
+> **tempFilePath**: `string`
+
+临时文件路径（需先通过下载或其他方式获得的临时文件路径）。
+
+<a id="savefileresult"></a>
+<a id="savedfilepath"></a>
+### SaveFileResult
+
+[FileSystemManager.saveFile](#savefile) 的返回结果。
+
+#### Properties
+
+##### savedFilePath
+
+> **savedFilePath**: `string`
+
+文件保存后的实际存储路径。
+
+<a id="statparams"></a>
+### StatParams
+
+[FileSystemManager.stat](#stat) 的参数。
+
+#### Properties
+
+##### path
+
+> **path**: `string`
+
+要获取状态信息的文件或目录路径。
+
+<a id="statresult"></a>
+### StatResult
+
+[FileSystemManager.stat](#stat) 的返回结果。
+
+#### Properties
+
+##### isDirectory
+
+> **isDirectory**: `boolean`
+
+判断当前路径是否是一个目录。
+
+##### lastModifiedTime
+
+> **lastModifiedTime**: `number`
+
+文件最近一次被修改的时间戳，单位为毫秒。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位为字节（Byte）。
+
+<a id="truncateparams"></a>
+### TruncateParams
+
+[FileSystemManager.truncate](#truncate) 的参数。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+要截断的文件路径。
+
+##### length?
+
+> `optional` **length**: `number`
+
+截断后的文件字节长度。
+
+- 若 `length` 小于文件原始长度，文件将被截取到指定长度，多余部分丢弃。
+- 若 `length` 大于文件原始长度，文件将被扩展到指定长度，扩展部分用 `\0` 填充。
+
+###### Default
+
+```ts
+0
+```
+
+<a id="unlinkparams"></a>
+### UnlinkParams
+
+[FileSystemManager.unlink](#unlink) 的参数。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+要删除的文件路径。
+
+该接口只能删除文件，不能删除目录；删除目录应使用 [FileSystemManager.rmdir](#rmdir)。
+
+<a id="unzipparams"></a>
+### UnzipParams
+
+[FileSystemManager.unzip](#unzip) 的参数。
+
+#### Properties
+
+##### targetPath
+
+> **targetPath**: `string`
+
+解压后的目标目录路径。
+
+目标目录须已存在，否则解压会失败。
+
+##### zipFilePath
+
+> **zipFilePath**: `string`
+
+要解压的 zip 文件路径。
+
+<a id="writefileparams"></a>
+### WriteFileParams
+
+[FileSystemManager.writeFile](#writefile) 的参数。
+
+#### Remarks
+
+- 如果文件不存在会自动创建；如果文件已存在则会覆盖原有内容。
+- 父目录不存在时写入会失败，需先通过 [FileSystemManager.mkdir](#mkdir) 创建目录。
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+要写入的内容。
+
+- 当 `encoding` 为 `'utf-8'` 时，直接写入该字符串；
+- 当 `encoding` 为 `'base64'` 时，将该字符串先进行 Base64 解码再写入文件。
+
+##### encoding?
+
+> `optional` **encoding**: `"base64"` \| `"utf-8"`
+
+指定写入文件的字符编码。
+
+###### Default
+
+```ts
+'utf-8'
+```
+
+##### filePath
+
+> **filePath**: `string`
+
+要写入的文件路径（本地路径）。