### Hierarchy

- InspectOptions
  - InspectOptions

## Index

### Properties

- breakLength
- colors
- compact
- customInspect
- depth
- getters
- maxArrayLength
- showHidden
- showProxy
- sorted

## Properties

### Optional breakLength

breakLength: undefined | number

- Defined in node_modules/@types/node/globals.d.ts:467

### Optional colors

colors: undefined | false | true

- Defined in node_modules/@types/node/globals.d.ts:463

### Optional compact

compact: boolean | number

- Defined in node_modules/@types/node/globals.d.ts:478

Setting this to `false` causes each object key to be displayed on a new line. It will also add new lines to text that is longer than `breakLength`. If set to a number, the most `n` inner elements are united on a single line as long as all properties fit into `breakLength`. Short array elements are also grouped together. Note that no text will be reduced below 16 characters, no matter the `breakLength` size. For more information, see the example below.

default

  `true`

### Optional customInspect

customInspect: undefined | false | true

- Defined in node_modules/@types/node/globals.d.ts:464

### Optional depth

depth: number | null

- Defined in node_modules/@types/node/globals.d.ts:462

default

  2

### Optional getters

getters: "get" | "set" | boolean

- Defined in node_modules/@types/node/globals.d.ts:457

If set to `true`, getters are going to be inspected as well. If set to `'get'` only getters without setter are going to be inspected. If set to `'set'` only getters having a corresponding setter are going to be inspected. This might cause side effects depending on the getter function.

default

  `false`

### Optional maxArrayLength

maxArrayLength: number | null

- Defined in node_modules/@types/node/globals.d.ts:466

### Optional showHidden

showHidden: undefined | false | true

- Defined in node_modules/@types/node/globals.d.ts:458

### Optional showProxy

showProxy: undefined | false | true

- Defined in node_modules/@types/node/globals.d.ts:465

### Optional sorted

sorted: boolean | function

- Defined in node_modules/@types/node/globals.d.ts:479

Generated using TypeDoc