# preview2

> Console logging, inspecting and debugging tool.

Latest version **0.2.6** (published 2018-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install preview2
pnpm add preview2
yarn add preview2
bun add preview2
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2018-10-10 |
| First published | 2018-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 1 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mark W. B. Ashcroft |
| Maintainers | fluidecho |
| Keywords | debug, log, logging, inspect, console |

## Links

- npm: https://www.npmjs.com/package/preview2
- Repository: https://github.com/fluidecho/preview2
- Issues: http://github.com/fluidecho/preview2/issues
- npm.io page: https://npm.io/package/preview2

## Dependencies (1)

- [minimist](https://npm.io/package/minimist.md) ~1.2.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.2.6 (latest) — 2018-10-10
- 0.2.5 — 2018-10-10
- 0.2.4 — 2018-10-09
- 0.2.3 — 2018-10-09
- 0.2.2 — 2018-10-09
- 0.2.1 — 2018-10-09
- 0.2.0 — 2018-10-09

## README

# Preview2

[![build status][travis-image]][travis-url]
[![NPM version][npm-image]][npm-url]
[![node version][node-image]][node-url]

[travis-image]: https://api.travis-ci.org/fluidecho/preview2.png
[travis-url]: https://travis-ci.org/fluidecho/preview2
[npm-image]: https://img.shields.io/npm/v/preview2.svg?style=flat-square
[npm-url]: https://npmjs.org/package/preview2
[node-image]: https://img.shields.io/badge/node.js-%3E=_8-blue.svg?style=flat-square
[node-url]: http://nodejs.org/download/

Console logging, inspecting and debugging tool.  

Instead of having console.log and util.inspect all over your code during development, use preview and can then turn object printing on or off using _--preview_ argument.

_Simpler than [Preview](https://www.npmjs.com/package/preview)._

## Installation

From your terminal, requires [node.js](http://nodejs.org/).

```
npm install preview2
```

## Example

In TypeScript.

```
/// <reference types="@types/node" />
//
// ts-node example.ts --preview
//

import { preview, Log } from 'preview2';

const log: Log = preview(__filename);

log('will always print', undefined, true);

let foo: any = {bar: 8211, hello: 'world', list: [1,2,3]};   // some object to inspect.
 
log('foo');
log('foo object', foo);
log(foo);
```
Run:
```
ts-node example.ts --preview
```

## License

Choose either: [MIT](http://opensource.org/licenses/MIT) or [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).

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