# power-assert-renderer-comparison

> comparison renderer for power-assert context

Latest version **1.2.0** (published 2018-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install power-assert-renderer-comparison
pnpm add power-assert-renderer-comparison
yarn add power-assert-renderer-comparison
bun add power-assert-renderer-comparison
```

## 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 | 1.2.0 |
| Published | 2018-06-12 |
| First published | 2016-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Takuto Wada |
| Maintainers | twada |
| Keywords | power-assert |

## Links

- npm: https://www.npmjs.com/package/power-assert-renderer-comparison
- Repository: https://github.com/twada/power-assert-runtime
- Issues: https://github.com/twada/power-assert-runtime/issues
- npm.io page: https://npm.io/package/power-assert-renderer-comparison

## Dependencies (5)

- [core-js](https://npm.io/package/core-js.md) ^2.0.0
- [type-name](https://npm.io/package/type-name.md) ^2.0.1
- [stringifier](https://npm.io/package/stringifier.md) ^1.3.0
- [diff-match-patch](https://npm.io/package/diff-match-patch.md) ^1.0.0
- [power-assert-renderer-base](https://npm.io/package/power-assert-renderer-base.md) ^1.1.1

## Recent versions

- 1.2.0 (latest) — 2018-06-12
- 1.1.1 — 2016-11-10
- 1.1.0 — 2016-10-07
- 1.0.7 — 2016-07-01
- 1.0.6 — 2016-06-05
- 1.0.5 — 2016-06-05
- 1.0.1 — 2016-05-31
- 1.0.0 — 2016-05-31
- 0.1.0 — 2016-04-06

## README

[![power-assert][power-assert-banner]][power-assert-url]

[![Build Status][travis-image]][travis-url]
[![NPM version][npm-image]][npm-url]
[![License][license-image]][license-url]


Produces comparison of expected and actual values of `BinaryExpression`.

```
  assert(a.name === 'bar')
  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar
```


USAGE
---------------------------------------

`var ComparisonRenderer = require('power-assert-renderer-comparison');`


#### options.stringify

| type       | default value |
|:-----------|:--------------|
| `function` | [stringifier module](https://github.com/twada/stringifier) |

Function to stringify any target value.


#### options.maxDepth

| type     | default value |
|:---------|:--------------|
| `number` | `2`           |

Depth of object traversal. If object depth is greater than `maxDepth`, compound object (IOW, `Array` or `object`) will be pruned with `#` like `["foo",#Array#,#Object#]`.


#### options.lineSeparator

| type     | default value |
|:---------|:--------------|
| `string` | `"\n"`        |

Line separator in power assert output.


#### options.anonymous

| type     | default value |
|:---------|:--------------|
| `string` | `"Object"`    |

Type name to show when target object is created by anonymous constructor.


#### options.circular

| type     | default value   |
|:---------|:----------------|
| `string` | `"#@Circular#"` |

Name to show when target object is detected as circular structure.


#### options.diff

| type       | default value |
|:-----------|:--------------|
| `function` | [udiff.js](https://github.com/twada/power-assert-runtime/blob/master/packages/power-assert-renderer-comparison/lib/udiff.js) |

Function to create diff string between two strings.


#### options.lineDiffThreshold

| type     | default value |
|:---------|:--------------|
| `number` | `5`           |

Threshold to show diff at character level or line level. If number of lines in target string is greater than `lineDiffThreshold`, then line diff mode will be used to show diff output.



INSTALL
---------------------------------------

```sh
$ npm install --save-dev power-assert-renderer-comparison
```


AUTHOR
---------------------------------------
* [Takuto Wada](https://github.com/twada)


LICENSE
---------------------------------------
Licensed under the [MIT](https://github.com/twada/power-assert-runtime/blob/master/LICENSE) license.


[power-assert-url]: https://github.com/power-assert-js/power-assert
[power-assert-banner]: https://raw.githubusercontent.com/power-assert-js/power-assert-js-logo/master/banner/banner-official-fullcolor.png

[travis-url]: https://travis-ci.org/twada/power-assert-runtime
[travis-image]: https://secure.travis-ci.org/twada/power-assert-runtime.svg?branch=master

[npm-url]: https://npmjs.org/package/power-assert-renderer-comparison
[npm-image]: https://badge.fury.io/js/power-assert-renderer-comparison.svg

[license-url]: https://github.com/twada/power-assert-runtime/blob/master/LICENSE
[license-image]: https://img.shields.io/badge/license-MIT-brightgreen.svg

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