模块: 文件系统

大约 8 分钟

模块: 文件系统

导入 文件系统 模块：

在.js文件中

import * as wifi from '文件系统'

在REPL命令行下

import 文件系统

模块函数

函数 mkdirSync

原型: mkdirSync (path:string, recursive:bool=false)

同步创建目录

参数:

path
类型string
参数说明路径
recursive=false
类型bool
默认值false
参数说明是否递归创建目录

返回值:

类型bool

函数 rmdirSync

原型: rmdirSync (path:string)

同步删除目录。如果目录非空返回 false。

参数:

path
类型string
参数说明路径

返回值:

类型bool

函数 unlinkSync

原型: unlinkSync (path:string)

同步删除文件

参数:

path
类型string
参数说明路径

返回值:

类型bool

函数 readFileSync

原型: readFileSync (path:string, readlen:number=-1, offset:number=0)

同步读取文件

函数返回的是一个 ArrayBuffer 对象，可以使用 ArrayBuffer.prototype.asString() 方法转换为字符串，例如：
let content = fs.readFileSync("~/foo.bar").asString()
console.log(content)

参数:

path
类型string
参数说明路径
readlen=-1
类型number
默认值-1
参数说明读取长度，-1表示全文
offset=0
类型number
默认值0
参数说明开始位置

返回值:

类型ArrayBuffer

函数 writeFileSync

原型: writeFileSync (path:string, data:string|ArrayBuffer, append:bool=false)

同步写入文件，返回写入字节数量

参数:

path
类型string
参数说明路径
data
类型string, ArrayBuffer
参数说明数据内容
append=false
类型bool
默认值false
参数说明是否追加写入

返回值:

类型number

函数 readdirSync

原型: readdirSync (path:string, detail:bool=false)

同步读取目录下的所有成员。

如果 detail 参数为 false，仅返回文件名数字。

如果 detail 参数为 true，返回一个数组，数组元素为对象，对象格式如下：

[
    {
        name: string ,
        type: "file"|"dir"|"unknown" ,
        size: number
    } ,
    ...
]

参数:

path
类型string
参数说明路径
detail=false
类型bool
默认值false
参数说明是否范围详细信息

返回值:

类型string[]

| object[]

函数 statSync

原型: statSync (path:string)

同步返回文件状态如果文件不存在,返回 null; 否则返回包含详细信息的对象

返回对象格式:

{
    dev:number,
    ino:number,
    mode:number,
    size:number,
    isDir:bool,
    atime:number,
    mtime:number,
    ctime:number
}

参数:

path
类型string
参数说明文件路径

返回值:

类型null

| object

函数 existsSync

原型: existsSync (path:string)

同步返回路径是否存在

参数:

path
类型string
参数说明路径

返回值:

类型bool

函数 isFileSync

原型: isFileSync (path:string)

同步返回路径是否存在

参数:

path
类型string
参数说明路径

返回值:

类型bool

函数 isDirSync

原型: isDirSync (path:string)

同步返回路径是否存在

参数:

path
类型string
参数说明路径

返回值:

类型bool

函数 open

原型: open (path, mode="rw")

打开文件，返回文件句柄，用于后续操作

参数:

path
类型undefined
参数说明string 文件路径
mode="rw"
类型undefined
参数说明string 打开方式

返回值:

类型number

函数 read

原型: read (handle, length)

从文件中读指定长度的数据, 如果遇到错误抛出异常

import {open,read,close} from "fs"

const handle = open("/sdcard/test.txt", "w") ;
const data = read(handle, 10) ;
console.log("readed string:",data.toString()) ;
close(handle) ;

参数:

handle
类型undefined
参数说明number 由open()返回的文件句柄
length
类型undefined
参数说明number 读取长度

返回值:

类型ArrayBuffer

函数 write

原型: write (handle, data)

向文件写入数据,返回写入的字节数

import {open,write,close} from "fs"

const handle = open("/sdcard/test.txt", "w") ;
let wrote = write(handle, "hello world") ;
console.log("wrote bytes:",wrote) ;
close(handle) ;