# fs-equals

> test pieces of the file system for equality

Latest version **0.2.6** (published 2013-11-23) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2013-11-23 |
| First published | 2013-04-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jake Rosoman |
| Maintainers | jkroso |
| Keywords | equals, equals, fs, test, dir, file |

## Links

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

## Dependencies (6)

- [every](https://npm.io/package/every.md) jkroso/every#0.2.5
- [result](https://npm.io/package/result.md) ~0.4.4
- [foreach](https://npm.io/package/foreach.md) jkroso/forEach#0.8.8
- [lift-result](https://npm.io/package/lift-result.md) ~0.1.3
- [result-type](https://npm.io/package/result-type.md) 1.0.0
- [stream-equal](https://npm.io/package/stream-equal.md) 0.1.5

## 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.2.6 (latest) — 2013-11-23
- 0.2.5 — 2013-09-09
- 0.2.4 — 2013-07-17
- 0.2.3 — 2013-06-24
- 0.2.2 — 2013-06-23
- 0.2.1 — 2013-06-22
- 0.2.0 — 2013-06-22
- 0.1.4 — 2013-06-05
- 0.1.3 — 2013-04-29
- 0.1.2 — 2013-04-28
- 0.1.1 — 2013-04-28
- 0.1.0 — 2013-04-26

## README

# fs-equals

  test pieces of the file system for equality

## Getting Started

_With npm_  

	$ npm install fs-equals --save

then in your app:

```js
var equals = require('fs-equals')
var assert = require('fs-equals/assert')
```

## API

Each function is available as either an assertion or boolean predicate test. If your using this module in a test suite you probably want the assertion version since it will provide more useful information about failures

  - [equals()](#equals)
  - [dirs()](#dirs)
  - [files()](#files)

### equals(apath:String, bpath:String)

  compare whatever happens to be at either path. The result is returned as a [Result](//github.com/jkroso/result)

### dirs(apath:String, bpath:String)

  test the contents of two directories for equality

### files(apath:String, bpath:String)

  test the contents of two files for equality

## examples

  see the [tests](test/index.test.js)

## Running the tests

```bash
$ npm install
$ make test
```

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