# synonym-js

> BDD / TDD lightweight assertion framework for node

Latest version **0.0.3** (published 2013-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install synonym-js
pnpm add synonym-js
yarn add synonym-js
bun add synonym-js
```

## 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.0.3 |
| Published | 2013-09-13 |
| First published | 2013-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Robbie Marcelo |
| Maintainers | rbmrclo |
| Keywords | BDD, TDD, assertion, test, node, javascript |

## Links

- npm: https://www.npmjs.com/package/synonym-js
- Repository: https://github.com/rbmrclo/synonym-js
- Issues: https://github.com/rbmrclo/synonym-js/issues
- npm.io page: https://npm.io/package/synonym-js

## Dependencies (1)

- [assertion-error](https://npm.io/package/assertion-error.md) 1.0.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2013-09-13
- 0.0.2 — 2013-09-13
- 0.0.1 — 2013-09-12

## README

# Synonym.js


   Synonym is a (work-in-progress) lightweight assertion framework for node.js. 

    npm install -g synonym-js
    
### Example

    $ node
    > var Synonym = require('./lib/assertion.js');
    > var synInstance = new Synonym();
    
    // Add a failed assertion
    > synInstance.isEqual('This', 'That');
               // isEqual(input, expect)
    
    > synInstance.runTests();
    
        Tests: 1 failure of 1 example
        
        Expects: "That"
        Got: "This"
        
    // Add a success assertion
    > synInstance.isEqual('This', 'This');
    
    > synInstance.runTests();
    
        Tests: 1 failure | 1 success out of 2 examples
        
        Expects: "That"
        Got: "This"

### Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

### Acknowledgement

© 2013, Robbie Marcelo. Released under the MIT [License].

[License]: http://opensource.org/licenses/mit-license.php

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