# file-system

> Strengthen the ability of file system

Latest version **2.2.2** (published 2016-11-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install file-system
pnpm add file-system
yarn add file-system
bun add file-system
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2016-11-17 |
| First published | 2014-11-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 67 |
| Author | douzi |
| Maintainers | douzi |
| Keywords | file, recursive, recurse, fs, maker, node file, mkdir, rmdir, fs extra, file system |

## Links

- npm: https://www.npmjs.com/package/file-system
- Repository: https://github.com/douzi8/file-system
- Issues: https://github.com/douzi8/file-system/issues
- npm.io page: https://npm.io/package/file-system

## Dependencies (2)

- [file-match](https://npm.io/package/file-match.md) ^1.0.1
- [utils-extend](https://npm.io/package/utils-extend.md) ^1.0.4

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.2.2 (latest) — 2016-11-17
- 2.2.1 — 2015-04-20
- 2.1.3 — 2015-04-12
- 2.1.2 — 2015-04-10
- 2.1.1 — 2015-03-20
- 2.1.0 — 2015-03-02
- 2.0.0 — 2015-01-14
- 1.2.9 — 2014-12-18
- 1.2.8 — 2014-12-17
- 1.2.7 — 2014-12-10
- 1.2.6 — 2014-12-07
- 1.2.5 — 2014-12-02
- 1.2.4 — 2014-12-02
- 1.2.3 — 2014-12-01
- 1.2.2 — 2014-11-27
- … 10 more at https://npm.io/package/file-system/versions

## README

# file-system — Simplified file system
[![NPM](https://nodei.co/npm/file-system.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/file-system/)

This module make file opertaion apis simple, you don't need to care the dir exits. and the api is same as node's filesystem. This is no exists time cost for this plugin.  
```js
var fs = require('file-system');

fs.mkdir('1/2/3/4/5', [mode], function(err) {});
fs.mkdirSync('1/2/3/4/5', [mode]);
fs.writeFile('path/test.txt', 'aaa', function(err) {})
```

### install
```
npm install file-system --save
```

## API
### .fs
file extend node fs origin methods, and overwrite some methods with next list chart
```js
var file = require('file-system');
var fs = require('fs');

file.readFile === fs.readFile // true
```

### .mkdir
The api is same as node's mkdir

### .mkdirSync
The api is same as node's mkdir

### .writeFile
The api is same as node's writeFile

### .writeFileSync
The api is same as node's writeFile

### .fileMatch
The api equal [file-match](https://github.com/douzi8/file-match)
      
### .copyFile(srcpath, destpath, options)
Asynchronously copy a file into newpath
* {string} ``srcpath`` required
* {string} ``destpath`` required
* {object} ``options``
  * {string} ``options.encoding`` [options.encoding=utf8]
  * {function} ``options.done(err)``
  * {function} ``options.process(content)``  
  The process argument must return processed content
```js
fs.copyFile('deom.png', 'dest/demo.png', {
  done: function(err) {
    console.log('done');
  }
});
```

### .copyFileSync(srcpath, destpath, options)
The api same as copyFile, but it's synchronous
```js
fs.copyFileSync('demo.png', 'dest/demo.png');
fs.copyFileSync('demo.css', 'dest/demo.css', {
  process: function(contents) {
    return contents;
  }
})
```

### .recurse(dirpath, filter, callback)
Recurse into a directory, executing callback for each file and folder.
if the filename is undefiend, the callback is for folder, otherwise for file.
* {string} ``dirpath`` required
* {string|array|function} ``filter``  
If the filter is function, executing callback for all files and folder 
* {function} ``callback(filepath, filename, relative)``
```js
fs.recurse('path', function(filepath, relative, filename) { });

fs.recurse('path', [
  '*.css',
  '**/*.js', 
  'path/*.html',
  '!**/path/*.js'
], function(filepath, relative, filename) {  
  if (filename) {
  // it's file
  } else {
  // it's folder
  }
});

//  Only using files
fs.recurse('path', function(filepath, relative, filename) {  
  if (!filename) return;
});
```
[filter params description](https://github.com/douzi8/file-match#filter-description)

### .recurseSync(dirpath, filter, callback)
The api is same as recurse, but it is synchronous
```js
fs.recurseSync('path', function(filepath, relative, filename) {
  
});

fs.recurseSync('path', ['**/*.js', 'path/**/*.html'], function(filepath, relative, filename) {
  
});
```

### .rmdirSync(dirpath)
Recurse into a directory, remove all of the files and folder in this directory.
```js
fs.rmdirSync('path');
```

### .copySync(dirpath, destpath, options)
Recurse into a directory, copy all files into dest.
* {string} ``dirpath`` required
* {string} ``destpath`` required
* {object} ``options``
  * {string|array} ``options.filter``
  * {function} ``options.process(contents, filepath, relative)``  
  If custom the destpath, return object, otherwise return content
  * {string|array} ``options.noProcess``
```js
fs.copySync('path', 'dest', { clear: true });

fs.copySync('src', 'dest/src');

fs.copySync('src', 'dest/src', { filter: ['*.js', 'path/**/*.css'] });

fs.copySync('path', 'dest', { 
  noProcess: '**/*.{jpg, png}',            // Don't process images
  process: function(contents, filepath, relative) {
    // only process file content
    return contents;
    // or custom destpath
    return {
      contents: '',
      filepath: ''
    };
  } 
});

//Handler self files
fs.copySync('path', 'path', { filter: ['*.html.js'], process: function(contents, filepath) {} });
```

### .base64
Deprecated, move to [base64](https://github.com/douzi8/base64-img#base64filename-callback)
### .base64Sync
Deprecated, move to [base64Sync](https://github.com/douzi8/base64-img#base64syncfilename)

---
_Source: https://npm.io/package/file-system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._