# vow-fs

> File I/O by Vow

Latest version **0.3.6** (published 2016-08-05) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.6 |
| Published | 2016-08-05 |
| First published | 2013-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.6.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Dmitry Filatov |
| Maintainers | dfilatov |
| Keywords | vow, promise, file system |

## Links

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

## Dependencies (4)

- [vow](https://npm.io/package/vow.md) ^0.4.7
- [glob](https://npm.io/package/glob.md) ^7.0.5
- [uuid](https://npm.io/package/uuid.md) ^2.0.2
- [vow-queue](https://npm.io/package/vow-queue.md) ^0.4.1

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 0.3.6 (latest) — 2016-08-05
- 0.3.5 — 2016-04-19
- 0.3.4 — 2014-12-21
- 0.3.3 — 2014-10-20
- 0.3.2 — 2014-06-09
- 0.3.1 — 2014-01-27
- 0.3.0 — 2013-12-23
- 0.2.3 — 2013-08-05
- 0.2.2 — 2013-07-08
- 0.2.1 — 2013-07-05
- 0.2.0 — 2013-07-02
- 0.1.13 — 2013-06-06
- 0.1.12 — 2013-05-23
- 0.1.11 — 2013-05-13
- 0.1.10 — 2013-03-21
- … 12 more at https://npm.io/package/vow-fs/versions

## README

vow-fs [![NPM version](https://badge.fury.io/js/vow-fs.png)](http://badge.fury.io/js/vow-fs) [![Build Status](https://secure.travis-ci.org/dfilatov/vow-fs.png)](http://travis-ci.org/dfilatov/vow-fs)
======

[Vow](https://github.com/dfilatov/vow)-based file I/O for Node.js

Requirements
------------
Vow-fs works with Node.js 0.6 and above.

Getting Started
---------------
You can install vow-fs using Node Package Manager (npm):

    npm install vow-fs

####Usage####
````javascript
var fs = require('vow-fs');
````

API
---
####read(path, [encoding])####
Returns a promise for the file's content at a given ````path````.
####write(path, data, [encoding])####
Writes ````data```` to file at a given ````path````. Returns a promise for the completion of the operation.
####append(path, data, [encoding])####
Appends````data```` to file's content at a given ````path````. Returns a promise for the completion of the operation.
####remove(path)####
Removes a file at a given ````path````. Returns a promise for the completion of the operation.
####copy(sourcePath, targetPath)####
Copies a file from ````sourcePath```` to ````targetPath````. Returns a promise for the completion of the operation.
####move(sourcePath, targetPath)####
Moves a file or directory from ````sourcePath```` to ````targetPath````. Returns a promise for the completion of the operation.
####stat(path)####
Returns a promise for the metadata about the given ````path```` as a [Stats](http://nodejs.org/api/fs.html#fs_class_fs_stats) object.
####exists(path)####
Returns a promise for whether the given ````path```` exists.
####link(sourcePath, targetPath)####
Creates a hard link from the ````sourcePath```` to ````targetPath````.
####symLink(sourcePath, targetPath, [type=file])####
Creates a symbolic link from the ````sourcePath```` to ````targetPath````.
####chown(path, uid, gid)####
Changes the owner of a given ````path````.
####chmod(path, mode)####
Changes the mode of a given ````path```` to ````mode````.
####absolute(path)####
####isFile(path)####
Returns a promise for whether the given ````path```` is a file.
####isDir(path)####
Returns a promise for whether the given ````path```` is a directory.
####isSocket(path)####
Returns a promise for whether the given ````path```` is a socket.
####isSymLink(path)####
Returns a promise for whether the given ````path```` is a symbolic link.
####makeTmpFile([options])####
Makes a temporary file. Returns a promise with generated path to file.
The ````options````:
  * prefix (absent by default)
  * dir (operating system's directory for temp files by default)
  * ext (````.tmp```` by default)

####listDir(path)####
Returns a promise for a list of files and directories in directory at the given ````path````.
####makeDir(path, [mode=0777], [failIfExist=false])####
Makes a directory at a given ````path```` and any necessary subdirectories (like ````mkdir -p````). Returns a promise for the completion of the operation.
####removeDir(path)####
Recursively removes a directory at a given path (like ````remove -rf````). Returns a promise for the completion of the operation.
####glob(pattern, [options])####
Matches files using the patterns. See https://github.com/isaacs/node-glob for details.

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