# q-i

> Node.js objects inspector with color highlighting

Latest version **2.0.1** (published 2017-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install q-i
pnpm add q-i
yarn add q-i
bun add q-i
```

## 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 | 2.0.1 |
| Published | 2017-12-20 |
| First published | 2017-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Author | Artem Sapegin |
| Maintainers | sapegin |
| Keywords | node, inspect, inspector, object, print, printer, pretty, stringify, json, color, syntax, highlight |

## Links

- npm: https://www.npmjs.com/package/q-i
- Repository: https://github.com/sapegin/q-i
- Issues: https://github.com/sapegin/q-i/issues
- npm.io page: https://npm.io/package/q-i

## Dependencies (3)

- [ansi-styles](https://npm.io/package/ansi-styles.md) ^3.2.0
- [is-plain-object](https://npm.io/package/is-plain-object.md) ^2.0.4
- [stringify-object](https://npm.io/package/stringify-object.md) ^3.2.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.1 (latest) — 2017-12-20
- 2.0.0 — 2017-12-19
- 1.2.0 — 2017-09-25
- 1.1.4 — 2017-09-21
- 1.1.3 — 2017-09-21
- 1.1.2 — 2017-09-21
- 1.1.1 — 2017-09-21
- 1.1.0 — 2017-09-20
- 1.0.0 — 2017-09-19

## README

# q-i: Node.js objects inspector with color highlighting

[![npm](https://img.shields.io/npm/v/q-i.svg)](https://www.npmjs.com/package/q-i)
[![Build Status](https://travis-ci.org/sapegin/q-i.svg)](https://travis-ci.org/sapegin/q-i)

Useful for debugging big objects, like webpack configuration.

![](https://d3vv6lp55qjaqc.cloudfront.net/items/0S1R2F1u1i1E2h2z0R41/q-i.png)

[![Washing your code. A book on clean code for frontend developers](https://sapegin.me/images/washing-code-github.jpg)](https://sapegin.me/book/)

## Features

* Compact and readable output
* No unnecessary quotes
* Color highlighted
* Collapses huge arrays and objects (more than 30 items by default)

## Installation

```bash
npm install q-i
```

## Usage

```js
const { print, stringify } = require('q-i');

const obj = { a: { x: 41, y: { z: 42 } } };

print(obj);
console.log(stringify(obj));
/* =>
{
  a: {
    x: 41,
    y: {
      z: 42
    }
  }
}
*/
```

## Options

```js
print(obj, { maxItems: Infinity })
stringify(obj, { maxItems: Infinity })
```

### `maxItems` (default: 30)

Collapse arrays with more than `maxItems` items and objects with more than `maxItems` keys.

## Change log

The change log can be found on the [Releases page](https://github.com/sapegin/q-i/releases).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).

## Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.

<a href="https://www.buymeacoffee.com/sapegin" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/lato-orange.png" alt="Buy Me A Coffee" height="51" width="217" ></a>

## Authors and license

[Artem Sapegin](http://sapegin.me) and [contributors](https://github.com/sapegin/q-i/graphs/contributors).

MIT License, see the included [License.md](License.md) file.

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