# fs-tools

> fs helper utilities (walk, copy, mkdir -p)

Latest version **0.5.0** (published 2018-08-09) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install fs-tools
pnpm add fs-tools
yarn add fs-tools
bun add fs-tools
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2018-08-09 |
| First published | 2011-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 49.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Aleksey V Zapparov |
| Maintainers | trott, vitaly |
| Keywords | fs, file, utils |

## Links

- npm: https://www.npmjs.com/package/fs-tools
- Repository: https://github.com/Trott/fs-tools
- Issues: https://github.com/Trott/fs-tools/issues
- npm.io page: https://npm.io/package/fs-tools

## Dependencies (2)

- [async](https://npm.io/package/async.md) ~ 0.2.9
- [lodash](https://npm.io/package/lodash.md) ^4.17.10

## 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

- 0.5.0 (latest) — 2018-08-09
- 0.3.0 — 2016-09-29
- 0.2.11 — 2014-01-08
- 0.2.10 — 2013-03-14
- 0.2.9 — 2013-02-17
- 0.2.8 — 2013-01-08
- 0.2.7 — 2012-12-19
- 0.2.6 — 2012-10-15
- 0.2.5 — 2012-08-20
- 0.2.4 — 2012-08-19
- 0.2.3 — 2012-08-09
- 0.2.2 — 2012-06-26
- 0.2.1 — 2012-02-09
- 0.2.0 — 2012-02-08
- 0.1.1 — 2012-02-06
- … 1 more at https://npm.io/package/fs-tools/versions

## README

fs-tools
========

[![Build Status](https://secure.travis-ci.org/Trott/fs-tools.png)](http://travis-ci.org/Trott/fs-tools)

> Some file utilities. See [API Documentation](http://trott.github.com/fs-tools/#FsTools) for detailed info.

___This project is not maintained anymore because now actual and better alternatives are available___.

Consider using another package:

- [shelljs](https://www.npmjs.com/package/shelljs)
- [glob](https://www.npmjs.com/package/glob)
- [mkdirp](https://www.npmjs.com/package/mkdirp)
- [rimraf](https://www.npmjs.com/package/rimraf)

--------------------------------------------------------------------------------

### walk(path, [pattern,] iterator[, callback])

Recursively scan files by regex pattern & apply iterator to each. Iterator
applied only to files, not to directories. If given path is a file, iterator
will be called against it (if pattern allows it).

### walkSync(path, [pattern,] iterator)

Sync version of walk(). Throws exception on error.


### findSorted(path, [pattern,] callback)

Recursively collects files by regex pattern (if given, all files otherwise).


### remove(path, callback)

Recursively delete directory with all content.

### removeSync(path)

Sync version of remove(). Throws exception on error.


### mkdir(path, mode = '0755', callback)

Recursively make path.

### mkdirSync(path, mode = '0755')

Sync version of mkdir(). Throws exception on error.


### copy(src, dst, callback)

Copy file.


### move(src, dst, callback)

Move file.


### tmpdir([template])

Returns unique directory (at the moment of request) pathname.


## License

[MIT](https://github.com/Trott/fs-tools/blob/master/LICENSE)

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