Socket
Socket
Sign inDemoInstall

object-inspect

Package Overview
Dependencies
0
Maintainers
2
Versions
36
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

object-inspect

string representations of objects in node and the browser


Version published
Maintainers
2
Weekly downloads
47,079,997
decreased by-0.6%
Install size
92.6 kB

Weekly downloads

Package description

What is object-inspect?

The object-inspect npm package is a utility for inspecting JavaScript objects. It is often used for debugging and logging purposes, as it can provide a string representation of an object, including its properties and their values, even if they are not enumerable or are symbols. It can handle various types of JavaScript values, including objects, arrays, functions, and primitives.

What are object-inspect's main functionalities?

Inspecting objects

This feature allows you to get a string representation of an object, which includes all its properties and their values.

var inspect = require('object-inspect');
var obj = { foo: 'bar', baz: 42 };
console.log(inspect(obj));

Inspecting arrays

This feature allows you to get a string representation of an array, including its elements.

var inspect = require('object-inspect');
var arr = ['foo', 'bar', 42];
console.log(inspect(arr));

Inspecting functions

This feature allows you to get a string representation of a function, including its name and the function keyword.

var inspect = require('object-inspect');
function exampleFunc() {}
console.log(inspect(exampleFunc));

Inspecting symbols

This feature allows you to get a string representation of a symbol, including its description.

var inspect = require('object-inspect');
var sym = Symbol('foo');
console.log(inspect(sym));

Inspecting non-enumerable properties

This feature allows you to inspect objects with non-enumerable properties, which are included in the string representation.

var inspect = require('object-inspect');
var obj = Object.create(null, { foo: { value: 'bar', enumerable: false } });
console.log(inspect(obj));

Other packages similar to object-inspect

Readme

Source

object-inspect Version Badge

string representations of objects in node and the browser

github actions coverage dependency status dev dependency status License Downloads

npm badge

example

circular

var inspect = require('object-inspect');
var obj = { a: 1, b: [3,4] };
obj.c = obj;
console.log(inspect(obj));

dom element

var inspect = require('object-inspect');

var d = document.createElement('div');
d.setAttribute('id', 'beep');
d.innerHTML = '<b>wooo</b><i>iiiii</i>';

console.log(inspect([ d, { a: 3, b : 4, c: [5,6,[7,[8,[9]]]] } ]));

output:

[ <div id="beep">...</div>, { a: 3, b: 4, c: [ 5, 6, [ 7, [ 8, [ ... ] ] ] ] } ]

methods

var inspect = require('object-inspect')

var s = inspect(obj, opts={})

Return a string s with the string representation of obj up to a depth of opts.depth.

Additional options:

  • quoteStyle: must be "single" or "double", if present. Default 'single' for strings, 'double' for HTML elements.
  • maxStringLength: must be 0, a positive integer, Infinity, or null, if present. Default Infinity.
  • customInspect: When true, a custom inspect method function will be invoked (either undere the util.inspect.custom symbol, or the inspect property). When the string 'symbol', only the symbol method will be invoked. Default true.
  • indent: must be "\t", null, or a positive integer. Default null.
  • numericSeparator: must be a boolean, if present. Default false. If true, all numbers will be printed with numeric separators (eg, 1234.5678 will be printed as '1_234.567_8')

install

With npm do:

npm install object-inspect

license

MIT

Keywords

FAQs

Last updated on 12 Jan 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc