https://github.com/xotic750/inspect-x

An implementation of node's inspect module.
https://github.com/xotic750/inspect-x

browser ecmascript inspect nodejs

Last synced: 2 months ago
JSON representation

An implementation of node's inspect module.

• Host: GitHub
• URL: https://github.com/xotic750/inspect-x
• Owner: Xotic750
• License: mit
• Created: 2015-12-04T03:26:31.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T22:43:44.000Z (about 2 years ago)
• Last Synced: 2024-11-14T09:59:03.779Z (2 months ago)
• Topics: browser, ecmascript, inspect, nodejs
• Language: JavaScript
• Size: 5.82 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        












































## inspect-x

An implementation of node's ES6 inspect module.

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



### `module.exports` ⇒ string ⏏

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**: string - The string representation.

| Param  | Type                | Description                         |

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

| obj    | Object | The object to print out.            |

| [opts] | Object | 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' } }

```