API Docs for:
Show:

FileSystemUtil Class

Module: happy_util

文件系统帮助函数库。

Item Index

Methods

Methods

eachFileSync

(
  • direction
  • filter
  • callback
  • [recursive=true]
)
static

递归遍历指定目录下的所有文件。

Parameters:

  • direction String

    要遍历的目录

  • filter RegExp | Function

    如果是正则表达,则必须满足正则表达式的要求;如果是函数,则函数的返回值必须为 true,函数的签名为:function(filename){ return true; }。

  • callback Function

    对于遍历到的文件执行的回调函数,该函数如果 return false 会导致遍历终止,函数签名如下:

    • filepath String

      完整的文件路径

    • filename String

      文件名 + 文件后缀

  • [recursive=true] Boolean optional

    是否递归子目录

Returns:

Example:

   FileSystemUtil.eachFileSync('../FileSystemUtil', /.*\.txt/, function (filepath, filename) {
       console.log(filepath);
       console.log(filename);
   });

mkdirSync

(
  • direction
)
static

创建目录,解决了fs.mkdirSync只能创建一级子目录的问题。

Parameters:

  • direction String

    目录路径

Returns:

Example:

   FileSystemUtil.mkdirSync('./a/b');

writeFileSync

(
  • filename
  • content
  • [encoding='utf8']
)
static

写入文件,解决了fs.writeFileSync写入文件必须要求目录存在的问题。

Parameters:

  • filename String

    文件路径

  • content String

    文件内容

  • [encoding='utf8'] String optional

    文件编码

Returns:

Example:

   FileSystemUtil.mkdirSync('./a/b');