fs-syncx
** It is recommended to use the async version of this package: m-fs. Use this package only when you can't use async functions **
Useful sync methods for file system.
Installation
# npm npm install --save fs-syncx# yarn yarn add fs-syncxJavaScript:
const fss = ;TypeScript:
;Run tests
# npm npm test# yarn yarn testAPI
the catchExp argument
It is crucial to first understand how fs-syncx API handles errors. Almost every API provided by fs-syncx contains an argument named catchExp.
Possible values:
- [Default]
undefinedorfalse: ignores all errors. Returns an empty valuenullorfalse. true: let any error throw. This is the same behavior like original Node.js fs sync APIs.(state, error) => {}callback: reports all errors in a callback.
Examples:
const fss = ;const FILE = '/__file_does_not_exist__'; // catchExp is false, no error is thrown, returns false if errors occurfss;// false // catchExp is a callback, use callback to get errorsfss;// state: /__file_does_not_exist__, error: Error: ENOENT: no such file or directory, lstat '/__file_does_not_exist__'// false // catchExp is true, just throw errorsfss;// *** Error thrown ***/* Error: ENOENT: no such file or directory, lstat '/__file_does_not_exist__' at Object.fs.lstatSync (fs.js:947:11) ...*/Note that using a callback as catchExp is especially useful when you want to get multiple errors, for example:
/* list all files recursively in a directory */ // catchExp is true, if accessing a directory throws an error, the function failed with that errorfss;// *** Error thrown ***/* Some directory is not accessible... */ // if catchExp is a callback, all errors will be reported and the function won't stop executingfss;// state: some directory, error: not accessible// state: some directory, error: not accessible// state: some directory, error: system error// returns an array of FileInfosAPIs
pathInfo
Returns an PathInfo object containing information about a given path.
: PathInfoPathInfo object:
name: 'abc' // the name of the path path: './abc' // the original path object you passed in fullPath: '/users/mgen/documents/abc' // the absolute resolved path isDir: true // true if the path is a directory isFile: false // true if the path is a file, stat: ... // raw object returned from fs.lstatSyncfileExists
Returns true if the given path is a file.
: booldirExists
Returns true if the given path is a directory.
: boollistDirs, listFiles, listPaths
listDirsreturns an array ofPathInforepresenting sub-directories in a directory.listStringDirslikelistDirs, returns an array ofstringinstead.listFilesreturns an array ofPathInforepresenting sub-files in a directory.listStringFileslikelistFiles, returns an array ofstringinstead.listPathsreturns an array ofPathInforepresenting all sub-paths in a directory.listStringPathslikelistPaths, returns an array ofstringinstead.
: PathInfo: string : PathInfo: string : PathInfo: stringpathpath string.optobject, possible properties:pathpath string.recursivelist children recursively, defaultfalse.
Note that these functions return an array of PathInfo objects, you can use JavaScript map function to convert them to an array of strings.
const fss = ;const DIR = 'node_modules'; // PathInfo.name: relative pathfss;// [ 'fs-syncx', 'is-string' ] // PathInfo.fullPath: absolute pathfss;/* [ '/Users/me/proj/node_modules/fs-syncx', '/Users/me/proj/node_modules/is-string' ] */readTextFile
Reads the contents of a file in UTF8 encoding. Like fs.readFile, but encoding defaults to utf8.
: stringwriteFileSync
Like fs.writeFileSync, but calls mkdir -p before writing the file.
License
MIT