https://github.com/futagoza/efe

enhanced fs-extra
https://github.com/futagoza/efe

Last synced: 18 days ago
JSON representation

enhanced fs-extra

• Host: GitHub
• URL: https://github.com/futagoza/efe
• Owner: futagoza
• License: mit
• Created: 2015-03-29T01:57:09.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-09-05T03:48:07.000Z (over 9 years ago)
• Last Synced: 2023-03-25T11:18:39.706Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 188 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# efe - Enhanced FS-Extra [![NPM version](https://img.shields.io/npm/v/efe.svg?style=flat)](https://www.npmjs.com/package/efe) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/futagoza/efe/blob/master/LICENSE)

[![Dependency Status](https://david-dm.org/futagoza/efe.svg)](https://david-dm.org/futagoza/efe)

[![devDependency Status](https://david-dm.org/futagoza/efe/dev-status.svg)](https://david-dm.org/futagoza/efe#info=devDependencies)

[![travis-ci](https://img.shields.io/travis/futagoza/efe/master.svg?label=travis-ci)](https://travis-ci.org/futagoza/efe)

[![appveyor](https://img.shields.io/appveyor/ci/futagoza/efe/master.svg?label=appveyor)](https://ci.appveyor.com/project/futagoza/efe/branch/master)

An enhanced version of [fs-extra](https://github.com/jprichardson/node-fs-extra)


# note

All properties from [fs-extra](https://www.npmjs.com/package/fs-extra) are shallow cloned when this module is required for the first time, which means extending this module's exports will not affect the use of `fs-extra` from anywhere else.

# install

  

```shell

npm install efe --save

```

# api usage

  

```js

var fs = require('efe');

// Ensures forward slashes are used on Windows

fs.enableForwardSlashes(); // or fs()

fs.disableForwardSlashes();

fs.resetNormalize();

// Removed `deprecated` warning when using `fs.exists(Sync)`

fs.exists(path, callback);

fs.existsSync(path);

// Attached methods from other modules to `efe`

fs.normalize(p);

fs.join([path1][, path2][, ...]);

fs.resolve([from ...], to);

fs.isAbsolute(path);

fs.relative(from, to);

fs.dirname(p);

fs.basename(p[, ext]);

fs.extname(p);

fs.sep

fs.delimiter

fs.parse(pathString);

fs.format(pathObject);

fs.Watcher(options);

fs.watch(paths, options);

fs.hasMagic(pattern, [options]);

fs.glob(pattern, [options], cb);

fs.globSync(pattern, [options]);

fs.Glob(pattern, [options], [cb]);

fs.writeFile(filename, data[, options], callback);

fs.writeFileSync(filename, data[, options]);

fs.Walker(root);

// Updated the `stats` objects returned by methods using `fs.Stats`

fs.stat(path, callback);

fs.statSync(path);

fs.lstat(path, callback);

fs.lstatSync(path);

fs.fstat(path, callback);

fs.fstatSync(path);

// Walk directory tree, firing `callback` on every item not a directory

fs.walk(path, callback);

fs.walkSync(path, callback);

// Check if the given path is of a specific type

fs.isFile(path, [callback])

fs.isFileSync(path)

fs.isDirectory(path, [callback])

fs.isDirectorySync(path)

fs.isBlockDevice(path, [callback])

fs.isBlockDeviceSync(path)

fs.isBlock(path, [callback])

fs.isBlockSync(path)

fs.isCharacterDevice(path, [callback])

fs.isCharacterDeviceSync(path)

fs.isCharacter(path, [callback])

fs.isCharacterSync(path)

fs.isSymbolicLink(path, [callback])

fs.isSymbolicLinkSync(path)

fs.isSymbolic(path, [callback])

fs.isSymbolicSync(path)

fs.isLink(path, [callback])

fs.isLinkSync(path)

fs.isFIFO(path, [callback])

fs.isFIFOSync(path)

fs.isSocket(path, [callback])

fs.isSocketSync(path)

// Return total size of the given path

fs.size(path, [options], [callback])

fs.sizeSync(path, [options])

```

# dependencies

  

  * fs-extra: [https://github.com/jprichardson/node-fs-extra](https://github.com/jprichardson/node-fs-extra)

  * chokidar: [https://github.com/paulmillr/chokidar](https://github.com/paulmillr/chokidar)

  * glob: [https://github.com/isaacs/node-glob](https://github.com/isaacs/node-glob)

  * walker: [https://github.com/daaku/nodejs-walker](https://github.com/daaku/nodejs-walker)

  * filesize: [https://github.com/avoidwork/filesize.js](https://github.com/avoidwork/filesize.js)

# efe links

  

  * npm release: [https://www.npmjs.com/package/efe](https://www.npmjs.com/package/efe)

  * source: [https://github.com/futagoza/efe](https://github.com/futagoza/efe)

  * issues: [https://github.com/futagoza/efe/issues](https://github.com/futagoza/efe/issues)

# license

Copyright (c) 2015 [Futago-za Ryuu](https://github.com/futagoza).


Released under the [MIT License](http://opensource.org/licenses/MIT)