ENGLISH

FS

使用 Promise 封装了一些常用的文件系统方法（基于 Node.js 的 fs 文件系统）

• stat

  读取文件状态

• mkDir

  创建文件夹

• access

  连接文件

• copyDir

  复制文件夹到指定位置，若文件夹已存在将被清空后进行复制操作

• readDir

  读取文件夹

• clearDir

  递归清空文件夹，若文件夹不存在将被创建

• emptyDir

  递归清空文件夹

• readFile

  读取文件

• writeFile

  写入文件

• dirForEach

  遍历文件夹

• fileForEach

  递归遍历文件

• unlinkDirFileByExtname

  递归删除指定 extname 的文件

npm 安装

$ npm install @jiaminghi/fs

使用

import { readFile } from '@jiaminghi/fs'

// do something

示例

stat

type stat = (
  path: fs.PathLike,
  options: fs.StatOptions = { bigint: false }
) => Promise<fs.Stats | fs.BigIntStats | false>

mkDir

type mkDir = (path: fs.PathLike, options: fs.MakeDirectoryOptions = {}) => Promise<boolean>

access

type access = (path: fs.PathLike, mode = fs.constants.F_OK) => Promise<boolean>

copyDir

type copyDir = (path: fs.PathLike, dest: string) => Promise<boolean>

readDir

type readDir = (path: fs.PathLike) => Promise<string[] | false>

clearDir

type clearDir = (path: fs.PathLike) => Promise<boolean>

emptyDir

type emptyDir = (path: fs.PathLike) => Promise<boolean>

readFile

type readFile = (
  path: fs.PathLike,
  options: { encoding: string; flag?: string } = { encoding: 'utf8' }
) => Promise<string | false>

writeFile

type writeFile = (
  path: fs.PathLike,
  data: any,
  option: fs.WriteFileOptions = 'utf8'
) => Promise<boolean>

dirForEach

type dirForEach = (path: fs.PathLike, callback: (path: string) => any) => Promise<boolean>

fileForEach

type fileForEach = (path: fs.PathLike, callback: (path: string) => any) => Promise<boolean>

unlinkDirFileByExtname

type unlinkDirFileByExtname = (path: fs.PathLike, extnames: string[] = []) => Promise<boolean>

0.1.1-alpha (2020-07-06)

Perfect

• Exception: Throw exception normally.

0.1.0-alpha (2020-05-01)

typescript

• typescript: Rewrite with typescript.

0.0.2-alpha (2019-07-10)

New

• access: Promise fs.access.

0.0.1-alpha (2019-07-09)

Bug Fixes

• Entry: Incorrect entry file setting.

0.0.0-alpha (2019-07-09)

Release

• stat: fs.stat.
• mkDir: fs.mkdir.
• readDir: fs.readdir.
• copyDir: Copy the folder to the specified location. If the folder already exists in the specified location, the folder will be cleared.
• clearDir: Recursively empty the specified folder, the folder will be created if it does not exist.
• emptyDir: Recursively empty the folder.
• readFile: fs.readFile.
• writeFile: fs.writeFile.
• dirForEach: Recursively traverse all folders.
• fileForEach: Recursively traverse all files.
• unlinkDirFileByExtname: Delete the specified extname file.