https://github.com/dmnsgn/value-inspector

Get a string representation of a value or an object. Pretty much like they look in Chrome DevTools.
https://github.com/dmnsgn/value-inspector

inspect inspector object prettify stringify

Last synced: 2 months ago
JSON representation

Get a string representation of a value or an object. Pretty much like they look in Chrome DevTools.

• Host: GitHub
• URL: https://github.com/dmnsgn/value-inspector
• Owner: dmnsgn
• License: mit
• Created: 2024-03-26T23:41:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-12T13:51:44.000Z (10 months ago)
• Last Synced: 2025-04-20T22:32:53.079Z (6 months ago)
• Topics: inspect, inspector, object, prettify, stringify
• Language: JavaScript
• Homepage: https://dmnsgn.github.io/value-inspector/
• Size: 1.15 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# value-inspector

[![npm version](https://img.shields.io/npm/v/value-inspector)](https://www.npmjs.com/package/value-inspector)

[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/value-inspector)

[![npm minzipped size](https://img.shields.io/bundlephobia/minzip/value-inspector)](https://bundlephobia.com/package/value-inspector)

[![dependencies](https://img.shields.io/librariesio/release/npm/value-inspector)](https://github.com/dmnsgn/value-inspector/blob/main/package.json)

[![types](https://img.shields.io/npm/types/value-inspector)](https://github.com/microsoft/TypeScript)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org)

[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)

[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)

[![license](https://img.shields.io/github/license/dmnsgn/value-inspector)](https://github.com/dmnsgn/value-inspector/blob/main/LICENSE.md)

Get a string representation of a value or an object. Pretty much like they look in Chrome DevTools.

[![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn)

[![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)

[![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn)

![](https://raw.githubusercontent.com/dmnsgn/value-inspector/main/screenshot.png)

## Installation

```bash

npm install value-inspector

```

## Usage

```js

import inspect from "value-inspector";

const obj = {

  primitiveNull: null,

  valueUndefined: undefined,

  booleanTrue: true,

  textString: "a string",

  textRegExp: new RegExp("$ 🐈"),

  numberZero: 0,

  numberOne: 1,

  obj: {

    zero: 0,

    one: { two: 2, three: { four: 4 } },

  },

  fun() {},

  array: [0, 1],

  arrayTyped: Float32Array.of(0, 1),

  collectionMap: new Map([

    [0, "zero"],

    [1, "one"],

  ]),

  collectionSet: new Set([0, 1]),

  [Symbol("bar")]: "symbol-bar-value",

  promise: Promise.resolve(),

};

inspect(obj);

// =>

// {

//   array: (2)[0, 1]

//   arrayTyped: Float32Array(2)[0, 1]

//   booleanTrue: true

//   circularArray: [Circular]

//   circularObject: [Circular]

//   collectionMap: [object Map]

//   collectionSet: [object Set]

//   fun: [Function: fun]

//   numberOne: 1

//   numberZero: 0

//   obj: {

//     one: {

//       three: [object Object],

//       two: 2

//     },

//     zero: 0

//   }

//   primitiveNull: null

//   promise: Promise {}

//   textRegExp: /\$ 🐈/

//   textString: "a string"

//   valueUndefined: undefined

//   Symbol(bar): "symbol-bar-value"

// }

```

## API

## Functions





inspect(value, [options]) ⇒ string





Inspect a value.





## Typedefs





Options : object









## inspect(value, [options]) ⇒ string

Inspect a value.

**Kind**: global function

**Returns**: string - A string representation of a value or an object.

| Param     | Type                             |

| --------- | -------------------------------- |

| value     | \*                  |

| [options] | [Options](#Options) |



## Options : object

**Kind**: global typedef

**Properties**

| Name               | Type                | Default                               | Description                                  |

| ------------------ | ------------------- | ------------------------------------- | -------------------------------------------- |

| [depth]            | number | 2                        | Specify levels to expand arrays and objects. |

| [stringLength]     | number | Number.POSITIVE_INFINITY | Length to truncate strings.                  |

| [collectionLength] | number | Number.POSITIVE_INFINITY | Length to slice arrays, Map and Set.         |

| [objectLength]     | number | Number.POSITIVE_INFINITY | Length to truncate object keys.              |

## License

MIT. See [license file](https://github.com/dmnsgn/value-inspector/blob/main/LICENSE.md).