Share via

InspectOptions interface

  • Reference
Package:
powerbi-client

Properties

breakLength

The length at which input values are split across multiple lines. Set to Infinity to format the input as a single line (in combination with compact set to true or any number >= 1).
colors

If true, the output is styled with ANSI color codes. Colors are customizable.
compact

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.
customInspect

If false, [util.inspect.custom](depth, opts, inspect) functions are not invoked.
depth

Specifies the number of times to recurse while formatting object. This is useful for inspecting large objects. To recurse up to the maximum call stack size pass Infinity or null.
getters

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.
maxArrayLength

Specifies the maximum number of Array, TypedArray, WeakMap, and WeakSet elements to include when formatting. Set to null or Infinity to show all elements. Set to 0 or negative to show no elements.
maxStringLength

Specifies the maximum number of characters to include when formatting. Set to null or Infinity to show all elements. Set to 0 or negative to show no characters.
numericSeparator

If set to true, an underscore is used to separate every three digits in all bigints and numbers.
showHidden

If true, object's non-enumerable symbols and properties are included in the formatted result. WeakMap and WeakSet entries are also included as well as user defined prototype properties (excluding method properties).
showProxy

If true, Proxy inspection includes the target and handler objects.
sorted

If set to true or a function, all properties of an object, and Set and Map entries are sorted in the resulting string. If set to true the default sort is used. If set to a function, it is used as a compare function.

Property Details

breakLength

The length at which input values are split across multiple lines. Set to Infinity to format the input as a single line (in combination with compact set to true or any number >= 1).

breakLength?: number

Property Value

number

colors

If true, the output is styled with ANSI color codes. Colors are customizable.

colors?: boolean

Property Value

boolean

compact

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.

compact?: number | boolean

Property Value

number | boolean

customInspect

If false, [util.inspect.custom](depth, opts, inspect) functions are not invoked.

customInspect?: boolean

Property Value

boolean

depth

Specifies the number of times to recurse while formatting object. This is useful for inspecting large objects. To recurse up to the maximum call stack size pass Infinity or null.

depth?: null | number

Property Value

null | number

getters

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.

getters?: boolean | "set" | "get"

Property Value

boolean | "set" | "get"

maxArrayLength

Specifies the maximum number of Array, TypedArray, WeakMap, and WeakSet elements to include when formatting. Set to null or Infinity to show all elements. Set to 0 or negative to show no elements.

maxArrayLength?: null | number

Property Value

null | number

maxStringLength

Specifies the maximum number of characters to include when formatting. Set to null or Infinity to show all elements. Set to 0 or negative to show no characters.

maxStringLength?: null | number

Property Value

null | number

numericSeparator

If set to true, an underscore is used to separate every three digits in all bigints and numbers.

numericSeparator?: boolean

Property Value

boolean

showHidden

If true, object's non-enumerable symbols and properties are included in the formatted result. WeakMap and WeakSet entries are also included as well as user defined prototype properties (excluding method properties).

showHidden?: boolean

Property Value

boolean

showProxy

If true, Proxy inspection includes the target and handler objects.

showProxy?: boolean

Property Value

boolean

sorted

If set to true or a function, all properties of an object, and Set and Map entries are sorted in the resulting string. If set to true the default sort is used. If set to a function, it is used as a compare function.

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

Property Value

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