Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InspectOptions

Hierarchy

Index

Properties

Optional breakLength

breakLength: undefined | number

Optional colors

colors: undefined | false | true

Optional compact

compact: boolean | number

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

Optional depth

depth: number | null
default

2

Optional getters

getters: "get" | "set" | boolean

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

Optional showHidden

showHidden: undefined | false | true

Optional showProxy

showProxy: undefined | false | true

Optional sorted

sorted: boolean | ((a: string, b: string) => number)