InspectContext interface

程序包:

powerbi-client

扩展

Required<InspectOptions>

继承属性

breakLength	跨多行拆分输入值的长度。 设置为 Infinity 将输入格式设置为单行（与 compact 设置为 true 或任何数字 >= 1结合使用）。
colors	如果 true，则输出采用 ANSI 颜色代码样式。 颜色是可自定义的。
compact	将此项设置为 false 会导致每个对象键在新行上显示。 它还会将新行添加到比 breakLength长的文本。 如果设置为数字，只要所有属性都适合 n，最 breakLength 内部元素就统一在一行中。 短数组元素也组合在一起。 请注意，无论 breakLength 大小如何，文本都不会减少到 16 个字符以下。 有关更多信息，请参见下面的示例。
customInspect	如果 false，则不会调用 [util.inspect.custom](depth, opts, inspect) 函数。
depth	指定格式化对象时递归的次数。 这对于检查大型对象非常有用。 若要递归到最大调用堆栈大小，请 Infinity 或 null传递。
getters	如果设置为 true，也将检查 getter。 如果设置为 'get' 将仅检查没有 setter 的 getter。 如果设置为 'set' 将仅检查具有相应 setter 的 getter。 这可能会导致副作用，具体取决于 getter 函数。
maxArrayLength	指定要在格式设置时包括的最大 Array数、TypedArray、WeakMap和 WeakSet 元素。 设置为 null 或 Infinity 以显示所有元素。 设置为 0 或负值，不显示任何元素。
maxStringLength	指定格式设置时要包含的最大字符数。 设置为 null 或 Infinity 以显示所有元素。 设置为 0 或负，不显示任何字符。
numericSeparator	如果设置为 true，则下划线用于分隔所有 bigint 和数字中的每三位数字。
showHidden	如果 true，则格式化结果中包含对象的不可枚举符号和属性。 还包括 WeakMap 和 WeakSet 条目以及用户定义的原型属性（不包括方法属性）。
showProxy	如果 true，Proxy 检查包括目标和处理程序对象。
sorted	如果设置为 true 或函数，则对象的所有属性，并在生成的字符串中对 Set 和 Map 项进行排序。 如果设置为 true 使用默认排序。 如果设置为函数，则将其用作比较函数。

方法

stylize(string, InspectStyle)

继承属性详细信息

breakLength

跨多行拆分输入值的长度。 设置为 Infinity 将输入格式设置为单行（与 compact 设置为 true 或任何数字 >= 1结合使用）。

breakLength: number

属性值

number

继承自 Required.breakLength

colors

如果 true，则输出采用 ANSI 颜色代码样式。 颜色是可自定义的。

colors: boolean

属性值

boolean

继承自 Required.colors

compact

将此项设置为 false 会导致每个对象键在新行上显示。 它还会将新行添加到比 breakLength长的文本。 如果设置为数字，只要所有属性都适合 n，最 breakLength 内部元素就统一在一行中。 短数组元素也组合在一起。 请注意，无论 breakLength 大小如何，文本都不会减少到 16 个字符以下。 有关更多信息，请参见下面的示例。

compact: number | boolean

属性值

number | boolean

继承自 Required.compact

customInspect

如果 false，则不会调用 [util.inspect.custom](depth, opts, inspect) 函数。

customInspect: boolean

属性值

boolean

继承自 Required.customInspect

depth

指定格式化对象时递归的次数。 这对于检查大型对象非常有用。 若要递归到最大调用堆栈大小，请 Infinity 或 null传递。

depth: number | null

属性值

number | null

继承自 Required.depth

getters

如果设置为 true，也将检查 getter。 如果设置为 'get' 将仅检查没有 setter 的 getter。 如果设置为 'set' 将仅检查具有相应 setter 的 getter。 这可能会导致副作用，具体取决于 getter 函数。

getters: boolean | "set" | "get"

属性值

boolean | "set" | "get"

继承自 Required.getters

maxArrayLength

指定要在格式设置时包括的最大 Array数、TypedArray、WeakMap和 WeakSet 元素。 设置为 null 或 Infinity 以显示所有元素。 设置为 0 或负值，不显示任何元素。

maxArrayLength: number | null

属性值

number | null

继承自 Required.maxArrayLength

maxStringLength

指定格式设置时要包含的最大字符数。 设置为 null 或 Infinity 以显示所有元素。 设置为 0 或负，不显示任何字符。

maxStringLength: number | null

属性值

number | null

继承自 Required.maxStringLength

numericSeparator

如果设置为 true，则下划线用于分隔所有 bigint 和数字中的每三位数字。

numericSeparator: boolean

属性值

boolean

继承自 Required.numericSeparator

showHidden

如果 true，则格式化结果中包含对象的不可枚举符号和属性。 还包括 WeakMap 和 WeakSet 条目以及用户定义的原型属性（不包括方法属性）。

showHidden: boolean

属性值

boolean

继承自 Required.showHidden

showProxy

如果 true，Proxy 检查包括目标和处理程序对象。

showProxy: boolean

属性值

boolean

继承自 Required.showProxy

sorted

如果设置为 true 或函数，则对象的所有属性，并在生成的字符串中对 Set 和 Map 项进行排序。 如果设置为 true 使用默认排序。 如果设置为函数，则将其用作比较函数。

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

属性值

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

继承自 Required.sorted

方法详细信息

stylize(string, InspectStyle)

function stylize(text: string, styleType: InspectStyle): string

参数

text

string

styleType

InspectStyle

返回

string