Global

Type Definitions

typeFsStat

Source:
Properties:
Name Type Attributes Description
size number
isFile function
isDirectory function
isSymbolicLink function
atime Date

The last time the file was accessed.

mtime Date

The last time the file was modified.

ctime Date <optional>

The last time the file status was changed.

birthtime Date

The creation time of the file.

Type:
  • object

typeGetChildrenFilesOptions

Source:
Properties:
Name Type Attributes Default Description
prefixDirName string <optional>
withFileTypes boolean <optional>
false

When false, the result is string[], like ['relative path1', 'relative path1', ...]. When true, the result is Object[], like [{ name: 'full path1', isDirectory: true} ...]

options.ignoresErr boolean <optional>
false

Even if an error occurs during processing, it will be ignored.

excludesSymlink boolean <optional>
false

Excluding symblic-links

matchedRegExp string <optional>

Ex. "\w+\.txt$"

ignoredRegExp string <optional>

Ex. "[_\-.]cache\d+"

Type:
  • object

typeReaddirSyncOptions

Source:
Properties:
Name Type Attributes Default Description
isOnlyFile boolean <optional>
false
isOnlyDir boolean <optional>
false
Type: