README_EN.md

中文

FS

Encapsulating some common file system methods with Promise (based Node.js - fs)

• stat

  fs.stat.

• mkDir

  fs.mkdir.

• access

  fs.access.

• copyDir

  Copy the folder to the specified location.

• readDir

  fs.readdir.

• clearDir

  Recursively empty the specified folder.

• emptyDir

  Recursively empty the specified folder.

• readFile

  fs.readFile.

• writeFile

  fs.writeFile.

• dirForEach

  Traverse all folders.

• fileForEach

  Recursively traverse all files.

• unlinkDirFileByExtname

  Delete the specified extname file.

Install with npm

$ npm install @jiaminghi/fs

Use

import { readFile } from '@jiaminghi/fs'

// do something

Examples

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>