@absolunet/fss

@absolunet/fss

fs / fs-extra / del sync wrapper

Install

$ npm install @absolunet/fss

Usage

const fss = require('@absolunet/fss');

fss.move('/path1/path2/path3', '/path4');

API

chmod(path)

Maps fs.chmodSync.

chown(path)

Maps fs.chownSync.

copy(src, dest, [options])

Maps fsExtra.copySync.

del(patterns, [options])

Maps del.sync.

ensureDir(dir)

Maps fsExtra.ensureDirSync.

exists(path)

Maps fs.existsSync.

move(src, dest, [options])

Simulate a mv(1) via a fsExtra.copySync and a fsExtra.removeSync.

src

Required
Type: String
Path of dir/file to move.

dest

Required
Type: String
Path of destination.

options

Type: Object
fsExtra.copySync options.

outputFile(file, data, [options])

Maps fsExtra.outputFileSync.

readdir(path[, options])

Maps fs.readdirSync.

readFile(path[, options])

Maps fs.readFileSync.

realpath(path[, options])

Maps fs.realpathSync.

remove(path)

Maps fsExtra.removeSync.

scandir(root, type, [options])

Uses klaw-sync to scan directory for files or directories.
Return Array of files / directories

root

Required
Type: string
Path of directory to scan.

type

Required
Type: string
Scan for file or dir

options.recursive

Type: Boolean
Scan in subdirectories
Default: false

options.fullPath

Type: String
Return full absolute path instead of relative path from scanned directory
Default: false

options.pattern

Type: String
Filter results with minimatch pattern
Default: '**'

options.keepJunk

Type: Boolean
Keep junk files (also filters out .gitkeep)
Default: false

stat(path)

Maps fs.statSync.

symlink(target, path[, type])

Maps fs.symlinkSync.

writeFile(file, data[, options])

Maps fs.writeFileSync.

License

MIT © Absolunet