介绍
unimodules-file-system-interface 是一个 NPM 包，提供了一套统一的文件系统 API，方便跨平台（包括 Web、iOS、Android）开发者对于文件存储、读取、写入、删除等操作进行封装，并提供了统一的使用方式，方便调用，减少了不必要的重复代码。
安装
在使用 unimodules-file-system-interface 前，需要先进行安装。使用以下命令进行安装：
npm install unimodules-file-system-interface
API
unimodules-file-system-interface 提供了以下 API：
1. FileSystem.readAsStringAsync(fileUri: string): Promise<string>
读取给定文件 URI 的文件内容，以字符串形式返回。
参数：
fileUri：String 类型，必填，文件 URI。
返回：
- 以字符串形式返回文件内容，如果出现异常，则会抛出异常。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
--------------------------------------------------------
--------------- -- -
----------------- ---------- ---------
--
-------------- -- -
---------------------
---2. FileSystem.writeAsStringAsync(fileUri: string, contents: string, options?: FileSystem.WritingOptions): Promise<void>
将给定字符串内容写入到指定的文件 URI 上。
参数：
fileUri：String 类型，必填，文件 URI。contents：String 类型，必填，要写入的内容。options：Object 类型，可选，写入选项。具体设置参见 FileSystem.WritingOptions。
返回：
- Promise<void>，写入完成后，Promise 将会被 resolve，否则将会被 reject。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
----- ------- - ------- --------
----- --- - ---------------------------
---------------------------------- --------
-------- -- -
----------------- -----------
--
-------------- -- -
---------------------
---3. FileSystem.getInfoAsync(fileUri: string, options?: FileSystem.InfoOptions): Promise<FileSystem.FileInfo>
获取指定文件 URI 的基本信息。
参数：
fileUri：String 类型，必填，文件 URI。options：Object 类型，可选，获取信息选项。具体设置参见 FileSystem.InfoOptions。
返回：
- Promise<FileSystem.FileInfo>，返回一个包含 URI、大小、最后修改时间等信息的对象。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
----- --- - ---------------------------
----------------------------
------------ -- -
----------------- ------- ------
--
-------------- -- -
---------------------
---4. FileSystem.deleteAsync(fileUri: string, options?: FileSystem.DeletionOptions): Promise<void>
删除指定的文件或目录。如果指定的是目录，则会先递归删除该目录下的所有文件和目录。
参数：
fileUri：String 类型，必填，文件或目录的 URI。options：Object 类型，可选，删除选项。具体设置参见 FileSystem.DeletionOptions。
返回：
- Promise<void>，删除完成后，Promise 将会被 resolve，否则将会被 reject。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
----- --- - ---------------------------
---------------------------
-------- -- -
----------------- -----------
--
-------------- -- -
---------------------
---5. FileSystem.makeDirectoryAsync(fileUri: string, options?: FileSystem.MakeDirectoryOptions): Promise<void>
在给定的 URI 上创建一个新的目录。如果目录已经存在，则什么都不做。
参数：
fileUri：String 类型，必填，要创建的目录 URI。options：Object 类型，可选，创建选项。具体设置参见 FileSystem.MakeDirectoryOptions。
返回：
- Promise<void>，创建完成后，Promise 将会被 resolve，否则将会被 reject。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
----- --- - ---------------------------------
----------------------------------
-------- -- -
---------------------- -----------
--
-------------- -- -
---------------------
---6. FileSystem.readDirectoryAsync(fileUri: string): Promise<string[]>
读取给定目录 URI 的内容，并以字符串数组的形式返回目录中的所有文件和目录名（不包括 '.' 和 '..'）。
参数：
fileUri：String 类型，必填，目录 URI。
返回：
- 以字符串数组的形式返回目录中的所有文件和目录名。
示例代码：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------------------
----- --- - -----------------------------
----------------------------------
--------------- -- -
---------------------- ---------- ---------
--
-------------- -- -
---------------------
---结束语
unimodules-file-system-interface 向导开发者提供了一套统一的跨平台文件操作 API，使开发者能够轻松地进行文件存储、读取、写入、删除等操作。同时，使用 unimodules-file-system-interface 也可以显著减少代码量，提高代码的复用性。
完整的 API 文档请参照该 NPM 包的官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedabd3b5cbfe1ea0610890