fs-extend v0.1.0

fs-extend

提供扩展原生fs模块不支持的功能

Usage

npm i fs-extend -S

const fsEx = require('fs-extend')
fsEx.mkdir('./1/2/3/4/5/6/7/8/9', (err) => {
  if (err) {
    return console.error(err)
  }
  console.log('ok')
})

Function

• mkdir(path, callback) 递归建立目录
• mkdirSync(path) 同步递归建立目录
• rm(path, callback) 删除目录及子目录
• rmSync(path) 同步删除目录及子目录
• find(path, pattern, callback) 查找path目录及子目录下匹配pattern的文件和目录。
• findSync(path, pattern) 同步查找path目录及子目录下匹配pattern的文件和目录。
• listFiles(path, callback) 列出目录及子目录下所有文件
• listFilesSync(path) 同步列出目录及子目录所有文件
• empty(path, callback) 判断目录是否空目录
• emptySync(path) 同步判断目录是否空目录

mkdir

• path \<string> 目录路径
• callback \<Function>
  • err \<Error>

递归建立目录

fsEx.mkdir('./1/2/3/4/5/6/7/8/9', (err) => {
  if (err) {
    return console.error(err)
  }
  console.log('ok')
})

mkdirSync

同步递归建立目录

• path \<string>

try {
  fsEx.mkdirSync('./1/2/3/4/5/6/7/8/9')
  console.log('ok')
} catch (err) {
  console.error(err)
}

rm

删除目录及子目录

• path \<string> 目录路径
• callback \<Function>
  • err \<Error>

fsEx.rm('./1', (err) => {
  if (err) {
    return console.error(err)
  }
  console.log('ok')
})

rmSync

同步删除目录及子目录。

• path \<string> 删除的目录

try {
  fsEx.rmSync('./1')
  console.log('ok')
} catch (err) {
  console.error(err)
}

find

查找path目录及子目录下匹配pattern的文件和目录。

• path \<string> 查找的目录。
• pattern \<string> | \<RegExp> 查找的模式。
• callback \<Function>
  • err \<Error>
  • result \<string[]> 查找的结果。

fsEx.find('.', '.jpg', (err, result) => {
  if (err) {
    return console.error(err)
  }
  console.log(result)
})

findSync

同步查找path目录及子目录下匹配pattern的文件和目录。

• path \<string> 目录路径。
• pattern \<string> | \<RegExp> 查找的模式。

try {
  const result = fsEx.findSync('.', '.jpg')
  console.log(result)
} catch (err) {
  console.error(err)
}

listFiles

列出目录及子目录下所有文件。

• path \<string>
• callback \<Function>
  • err \<Error>
  • result \<string[]> 文件列表。

fsEx.listFiles('.', (err, result) => {
  if (err) {
    return console.error(err)
  }
  console.log(result)
})

listFilesSync

同步列出目录及子目录所有文件。

try {
  const result = fsEx.listFilesSync('.')
  console.log(result)
} catch (err) {
  console.error(err)
}

empty

判断目录是否空目录

fsEx.empty('.', (err, isEmpty) => {
  if (err) {
    return console.error(err)
  }
  console.log('isEmpty: %s', isEmpty)
})

emptySync

同步判断目录是否空目录。

• path \<string>

try {
  const isEmpty = fsEx.emptySync('.')
  console.log('isEmpty: %s', isEmpty)
} catch (err) {
  console.error(err)
}