# inspect-x

> An implementation of node's ES6 inspect module.

Latest version **3.1.2** (published 2019-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install inspect-x
pnpm add inspect-x
yarn add inspect-x
bun add inspect-x
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.2 |
| Published | 2019-08-28 |
| First published | 2015-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8.11.4 |
| Dependencies | 56 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Graham Fairweather |
| Maintainers | xotic750 |
| Keywords | inspect, module, javascript, nodejs, browser |

## Links

- npm: https://www.npmjs.com/package/inspect-x
- Repository: https://github.com/Xotic750/inspect-x
- Issues: https://github.com/Xotic750/inspect-x/issues
- npm.io page: https://npm.io/package/inspect-x

## Dependencies (56)

- [json3](https://npm.io/package/json3.md) ^3.3.3
- [is-nan](https://npm.io/package/is-nan.md) ^1.2.1
- [is-map-x](https://npm.io/package/is-map-x.md) ^2.1.2
- [is-nil-x](https://npm.io/package/is-nil-x.md) ^2.1.1
- [is-regex](https://npm.io/package/is-regex.md) ^1.0.4
- [is-set-x](https://npm.io/package/is-set-x.md) ^2.1.2
- [is-string](https://npm.io/package/is-string.md) ^1.0.4
- [is-symbol](https://npm.io/package/is-symbol.md) ^1.0.2
- [object-is](https://npm.io/package/object-is.md) ^1.0.1
- [is-array-x](https://npm.io/package/is-array-x.md) ^2.1.2
- [is-error-x](https://npm.io/package/is-error-x.md) ^2.1.2
- [is-promise](https://npm.io/package/is-promise.md) ^2.1.0
- [array-map-x](https://npm.io/package/array-map-x.md) ^3.1.2
- [to-object-x](https://npm.io/package/to-object-x.md) ^2.2.1
- [to-string-x](https://npm.io/package/to-string-x.md) ^2.1.1
- [array-some-x](https://npm.io/package/array-some-x.md) ^3.1.2
- [math-clamp-x](https://npm.io/package/math-clamp-x.md) ^3.2.2
- [to-boolean-x](https://npm.io/package/to-boolean-x.md) ^2.1.1
- [to-integer-x](https://npm.io/package/to-integer-x.md) ^4.2.2
- [array-every-x](https://npm.io/package/array-every-x.md) ^3.1.2
- [array-slice-x](https://npm.io/package/array-slice-x.md) ^4.2.2
- [array-union-x](https://npm.io/package/array-union-x.md) ^3.1.2
- [collections-x](https://npm.io/package/collections-x.md) ^3.1.2
- [is-function-x](https://npm.io/package/is-function-x.md) ^4.1.2
- [object-keys-x](https://npm.io/package/object-keys-x.md) ^3.1.2
- [simple-call-x](https://npm.io/package/simple-call-x.md) ^1.0.3
- [white-space-x](https://npm.io/package/white-space-x.md) ^4.1.1
- [array-filter-x](https://npm.io/package/array-filter-x.md) ^3.1.2
- [array-reduce-x](https://npm.io/package/array-reduce-x.md) ^3.1.2
- [is-data-view-x](https://npm.io/package/is-data-view-x.md) ^2.1.2
- [is-date-object](https://npm.io/package/is-date-object.md) ^1.0.1
- [is-primitive-x](https://npm.io/package/is-primitive-x.md) ^1.0.1
- [is-typed-array](https://npm.io/package/is-typed-array.md) ^1.1.0
- [object-assign-x](https://npm.io/package/object-assign-x.md) ^2.1.2
- [to-iso-string-x](https://npm.io/package/to-iso-string-x.md) ^2.1.2
- [array-includes-x](https://npm.io/package/array-includes-x.md) ^3.1.2
- [is-number-object](https://npm.io/package/is-number-object.md) ^1.0.3
- [is-object-like-x](https://npm.io/package/is-object-like-x.md) ^2.1.2
- [is-array-buffer-x](https://npm.io/package/is-array-buffer-x.md) ^2.1.2
- [is-boolean-object](https://npm.io/package/is-boolean-object.md) ^1.0.0
- [string-includes-x](https://npm.io/package/string-includes-x.md) ^2.1.2
- [array-difference-x](https://npm.io/package/array-difference-x.md) ^3.1.2
- [get-prototype-of-x](https://npm.io/package/get-prototype-of-x.md) ^2.1.2
- [reflect-own-keys-x](https://npm.io/package/reflect-own-keys-x.md) ^3.1.2
- [simple-methodize-x](https://npm.io/package/simple-methodize-x.md) ^1.0.4
- [get-function-name-x](https://npm.io/package/get-function-name-x.md) ^3.1.2
- [is-async-function-x](https://npm.io/package/is-async-function-x.md) ^2.1.2
- [array-intersection-x](https://npm.io/package/array-intersection-x.md) ^3.1.2
- [has-symbol-support-x](https://npm.io/package/has-symbol-support-x.md) ^2.1.2
- [string-starts-with-x](https://npm.io/package/string-starts-with-x.md) ^2.1.2
- [is-generator-function](https://npm.io/package/is-generator-function.md) ^1.0.7
- [object-define-property-x](https://npm.io/package/object-define-property-x.md) ^5.1.2
- [get-own-property-symbols-x](https://npm.io/package/get-own-property-symbols-x.md) ^2.1.2
- [object-define-properties-x](https://npm.io/package/object-define-properties-x.md) ^5.1.2
- [require-object-coercible-x](https://npm.io/package/require-object-coercible-x.md) ^2.1.1
- [object-get-own-property-descriptor-x](https://npm.io/package/object-get-own-property-descriptor-x.md) ^4.1.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.1.2 (latest) — 2019-08-28
- 3.1.1 — 2019-08-20
- 3.1.0 — 2019-08-14
- 3.0.15 — 2019-08-05
- 3.0.14 — 2019-08-05
- 3.0.13 — 2019-08-05
- 3.0.12 — 2019-07-31
- 3.0.11 — 2019-07-27
- 3.0.10 — 2019-07-26
- 3.0.9 — 2019-07-25
- 3.0.8 — 2019-07-24
- 3.0.7 — 2019-07-24
- 3.0.6 — 2019-07-22
- 3.0.5 — 2019-07-22
- 3.0.4 — 2019-07-21
- … 33 more at https://npm.io/package/inspect-x/versions

## README

<a
  href="https://travis-ci.org/Xotic750/inspect-x"
  title="Travis status">
<img
  src="https://travis-ci.org/Xotic750/inspect-x.svg?branch=master"
  alt="Travis status" height="18">
</a>
<a
  href="https://david-dm.org/Xotic750/inspect-x"
  title="Dependency status">
<img src="https://david-dm.org/Xotic750/inspect-x/status.svg"
  alt="Dependency status" height="18"/>
</a>
<a
  href="https://david-dm.org/Xotic750/inspect-x?type=dev"
  title="devDependency status">
<img src="https://david-dm.org/Xotic750/inspect-x/dev-status.svg"
  alt="devDependency status" height="18"/>
</a>
<a
  href="https://badge.fury.io/js/inspect-x"
  title="npm version">
<img src="https://badge.fury.io/js/inspect-x.svg"
  alt="npm version" height="18">
</a>
<a
  href="https://www.jsdelivr.com/package/npm/inspect-x"
  title="jsDelivr hits">
<img src="https://data.jsdelivr.com/v1/package/npm/inspect-x/badge?style=rounded"
  alt="jsDelivr hits" height="18">
</a>
<a
  href="https://bettercodehub.com/results/Xotic750/inspect-x"
  title="bettercodehub score">
<img src="https://bettercodehub.com/edge/badge/Xotic750/inspect-x?branch=master"
  alt="bettercodehub score" height="18">
</a>
<a
  href="https://coveralls.io/github/Xotic750/inspect-x?branch=master"
  title="Coverage Status">
<img src="https://coveralls.io/repos/github/Xotic750/inspect-x/badge.svg?branch=master"
  alt="Coverage Status" height="18">
</a>

<a name="module_inspect-x"></a>

## inspect-x

An implementation of node's ES6 inspect module.

**See**: https://nodejs.org/api/util.html#util_util_inspect_object_options

<a name="exp_module_inspect-x--module.exports"></a>

### `module.exports` ⇒ <code>string</code> ⏏

Echos the value of a value. Trys to print the value out
in the best way possible given the different types.
Values may supply their own custom `inspect(depth, opts)` functions,
when called they receive the current depth in the recursive inspection,
as well as the options object passed to `inspect`.

**Kind**: Exported member  
**Returns**: <code>string</code> - The string representation.

| Param  | Type                | Description                         |
| ------ | ------------------- | ----------------------------------- |
| obj    | <code>Object</code> | The object to print out.            |
| [opts] | <code>Object</code> | Options object that alters the out. |

**Example**

```js
import inspect from 'inspect-x';

console.log(inspect(inspect, {showHidden: true, depth: null}));
//{ [Function: inspect]
//  [length]: 2,
//  [name]: 'inspect',
//  [prototype]: inspect { [constructor]: [Circular] },
//  [colors]:
//   { [bold]: [ 1, 22, [length]: 2 ],
//     [italic]: [ 3, 23, [length]: 2 ],
//     [underline]: [ 4, 24, [length]: 2 ],
//     [inverse]: [ 7, 27, [length]: 2 ],
//     [white]: [ 37, 39, [length]: 2 ],
//     [grey]: [ 90, 39, [length]: 2 ],
//     [black]: [ 30, 39, [length]: 2 ],
//     [blue]: [ 34, 39, [length]: 2 ],
//     [cyan]: [ 36, 39, [length]: 2 ],
//     [green]: [ 32, 39, [length]: 2 ],
//     [magenta]: [ 35, 39, [length]: 2 ],
//     [red]: [ 31, 39, [length]: 2 ],
//     [yellow]: [ 33, 39, [length]: 2 ] },
//  [styles]:
//   { [special]: 'cyan',
//     [number]: 'yellow',
//     [boolean]: 'yellow',
//     [undefined]: 'grey',
//     [null]: 'bold',
//     [string]: 'green',
//     [symbol]: 'green',
//     [date]: 'magenta',
//     [regexp]: 'red' } }
```

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