InspectorAPI

API

Last updated: March 17, 2026

API Reference

`inspect(value, options?)`

Inspect and format a value.

Options:

depth (number): Max depth
colors (boolean): Enable colors
showHidden (boolean): Show hidden properties

Returns: Formatted string

Example:

inspect(obj, {
    depth: 3,
    colors: true,
    showHidden: false,
});

Edit on GitHub

Contribute to our work and keep us going

Community is the heart of open source. The success of our packages wouldn't be possible without the incredible contributions of users, testers, and developers who collaborate with us every day.Want to get involved? Here are some tips on how you can make a meaningful impact on our open source projects.

Ready to help us out?

Be sure to check out the package's contribution guidelines first. They'll walk you through the process on how to properly submit an issue or pull request to our repositories.

Submit a pull request

Found something to improve? Fork the repo, make your changes, and open a PR. We review every contribution and provide feedback to help you get merged.

Good first issues

Simple issues suited for people new to open source development, and often a good place to start working on a package.

View good first issues

API