# @types/object-inspect

> TypeScript definitions for object-inspect

Latest version **1.13.0** (published 2024-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/object-inspect
pnpm add @types/object-inspect
yarn add @types/object-inspect
bun add @types/object-inspect
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.13.0 |
| Published | 2024-03-28 |
| First published | 2017-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51430 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/object-inspect
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-inspect
- npm.io page: https://npm.io/package/@types/object-inspect

## Recent versions

- 1.13.0 (latest) — 2024-03-28
- 1.8.4 (ts4.5) — 2023-11-07
- 1.8.2 (ts4.3) — 2023-09-03
- 1.8.1 (ts3.6) — 2021-07-07
- 1.8.0 (ts3.2) — 2020-10-28
- 1.6.1 (ts2.8) — 2020-02-07
- 1.6.0 (ts2.0) — 2019-11-05
- 1.8.3 — 2023-10-18
- 1.4.0 — 2017-11-12

## README

# Installation
> `npm install --save @types/object-inspect`

# Summary
This package contains type definitions for object-inspect (https://github.com/substack/object-inspect).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-inspect.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-inspect/index.d.ts)
````ts
declare namespace objectInspect {
    /**
     * Inspection options
     */
    interface Options {
        /**
         * Maximum depth of the inspection. Default: `5`.
         */
        depth?: number | undefined;
        /**
         * Must be "single" or "double", if present.
         */
        quoteStyle?: "single" | "double" | undefined;
        /**
         * Must be 0, a positive integer, Infinity, or null, if present. Default Infinity.
         */
        maxStringLength?: number | null | undefined;
        /**
         * When true, a custom inspect method function will be invoked (either under the util.inspect.custom symbol, or the inspect property). When the string 'symbol', only the symbol method will be invoked. Default true.
         */
        customInspect?: boolean | "symbol" | undefined;
        /**
         * Must be "\t", null, or a positive integer. Default null.
         */
        indent?: number | "\t" | null | undefined;
        /**
         * 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')
         */
        numericSeparator?: boolean | undefined;
    }
}

/**
 * Return a string `s` with the string representation of `obj` up to a depth of `opts.depth`.
 *
 * @param obj Object to inspect
 * @param opts Inspection options. Default: `{}`.
 * @return String representation of `obj`
 */
declare function objectInspect(obj: any, opts?: objectInspect.Options): string;

export = objectInspect;

````

### Additional Details
 * Last updated: Thu, 28 Mar 2024 04:35:21 GMT
 * Dependencies: none

# Credits
These definitions were written by [Charles Samborski](https://github.com/demurgos), [Akuukis](https://github.com/Akuukis), and [Jordan Harband](https://github.com/ljharb).

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