# inspect-with-kind

> `util.inspect` with additional type information

Latest version **1.0.5** (published 2018-08-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install inspect-with-kind
pnpm add inspect-with-kind
yarn add inspect-with-kind
bun add inspect-with-kind
```

## 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.0.5 |
| Published | 2018-08-28 |
| First published | 2017-03-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Shinnosuke Watanabe |
| Maintainers | shinnn |
| Keywords | inspect, format, beautify, clarify, stringify, type, kind, append, additional, info, check |

## Links

- npm: https://www.npmjs.com/package/inspect-with-kind
- Repository: https://github.com/shinnn/inspect-with-kind
- Homepage: https://github.com/shinnn/inspect-with-kind#readme
- Issues: https://github.com/shinnn/inspect-with-kind/issues
- npm.io page: https://npm.io/package/inspect-with-kind

## Dependencies (1)

- [kind-of](https://npm.io/package/kind-of.md) ^6.0.2

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2018-08-28
- 1.0.4 — 2017-12-13
- 1.0.3 — 2017-10-17
- 1.0.2 — 2017-06-26
- 1.0.1 — 2017-05-22
- 1.0.0 — 2017-03-09
- 0.0.0 — 2017-03-08

## README

# inspect-with-kind

[![npm version](https://img.shields.io/npm/v/inspect-with-kind.svg)](https://www.npmjs.com/package/inspect-with-kind)
[![Build Status](https://travis-ci.org/shinnn/inspect-with-kind.svg?branch=master)](https://travis-ci.org/shinnn/inspect-with-kind)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/inspect-with-kind.svg)](https://coveralls.io/github/shinnn/inspect-with-kind?branch=master)

[`util.inspect`][util.inspect] with additional type information

```javascript
const {inspect} = require('util');
const inspectWithKind = require('inspect-with-kind');

inspect([1, 2, 3]); //=> '[ 1, 2, 3 ]'
inspectWithKind([1, 2, 3]); //=> '[ 1, 2, 3 ] (array)'
```

## Installation

[Use npm.](https://docs.npmjs.com/cli/install)

```
npm install inspect-with-kind
```

## API

```javascript
const inspectWithKind = require('inspect-with-kind');
```

### inspectWithKind(*value* [, *options*])

*value*: any type  
*options*: `Object` ([`util.inspect`][util.inspect] options)  
Return: `string`

Almost the same as `util.inspect`, but:

* It appends a type information to the string if the first argument is one of `boolean`, `string`, `number`, `bigint`, `Array`, `RegExp`, `Date`, `arguments` or a plain `Object`.
* Error stack trace is omitted.
* `breakLength` option defaults to `Infinity`.
* `maxArrayLength` option defaults to `10`.

```javascript
const util = require('util');
const inspectWithKind = require('inspect-with-kind');

// appends type info
util.inspect(1); //=> '1'
inspectWithKind(1); //=> '1 (number)'
util.inspect('1'); //=> '\'1\''
inspectWithKind('1'); //=> '\'1\' (string)'

// doesn't appends type info, because <Buffer ...> clearly expresses what it is
util.inspect(Buffer.from('1')); //=> '<Buffer 31>'
inspectWithKind(Buffer.from('1')); //=> '<Buffer 31>'

// omits stack trace
util.inspect(new Error('error!')); //=> 'Error: error!\n    at repl:1:14\n    at ContextifyScript ...'
inspectWithKind(new Error('error!')); //=> 'Error: error!'
```

## Example

This module is useful for making `TypeError` error messages in your Node.js library.

```javascript
const inspectWithKind = require('inspect-with-kind');

module.exports = function reverse(v) {
  if (typeof v !== 'boolean') {
    throw new TypeError(`Expected a Boolean value, but got ${inspectWithKind(v)}.`);
  }

  return !v;
};
```

```javascript
const reverse = require('./reverse.js');

reverse(/true/); // TypeError: Expected a Boolean value, but got /true/ (regexp).
```

## License

[ISC License](./LICENSE) © 2017 Shinnosuke Watanabe

[util.inspect]: https://nodejs.org/api/util.html#util_util_inspect_object_options

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