# power-assert-renderer-diagram

> diagram 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-diagram
pnpm add power-assert-renderer-diagram
yarn add power-assert-renderer-diagram
bun add power-assert-renderer-diagram
```

## 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 | 4 |
| Unpacked size | 8.2 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-diagram
- 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-diagram

## Dependencies (4)

- [core-js](https://npm.io/package/core-js.md) ^2.0.0
- [stringifier](https://npm.io/package/stringifier.md) ^1.3.0
- [power-assert-renderer-base](https://npm.io/package/power-assert-renderer-base.md) ^1.1.1
- [power-assert-util-string-width](https://npm.io/package/power-assert-util-string-width.md) ^1.2.0

## Recent versions

- 1.2.0 (latest) — 2018-06-12
- 1.1.2 — 2017-04-14
- 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 graph of each value in expression.

```
  assert(a.name === 'bar')
         | |    |         
         | |    false     
         | "foo"          
         Object{name:"foo"}
```


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

`var DiagramRenderer = require('power-assert-renderer-diagram');`


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

| type       | default value |
|:-----------|:--------------|
| `function` | [power-assert-util-string-width](https://github.com/twada/power-assert-runtime/blob/master/packages/power-assert-util-string-width) |

Function to calculate width of string.


#### options.ambiguousEastAsianCharWidth

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

Width of 'Ambiguous' characters defined in [Unicode Standard Annex \#11 EAST ASIAN WIDTH](http://www.unicode.org/reports/tr11/#Ambiguous). Configure `options.ambiguousEastAsianCharWidth` to treat ambiguous east asian character as fullwidth (= `2`) or narrow (= `1`). Default is `2`.


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

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


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-diagram
[npm-image]: https://badge.fury.io/js/power-assert-renderer-diagram.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-diagram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._