API Reference / @gtkx/testing / prettyFormat / Options

Interface: Options

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:44

Extends

• Omit<RequiredOptions, "compareKeys" | "theme">

Properties

callToJSON

callToJSON: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:54

Call toJSON on objects before formatting them. Ignored after the formatter has already called toJSON once for a value.

Default

true

Inherited from

PrettyFormatOptions.callToJSON

---

compareKeys

compareKeys: CompareKeys

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:45

---

escapeRegex

escapeRegex: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:59

Whether to escape special characters in regular expressions.

Default

false

Inherited from

PrettyFormatOptions.escapeRegex

---

escapeString

escapeString: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:64

Whether to escape special characters in strings.

Default

true

Inherited from

PrettyFormatOptions.escapeString

---

highlight

highlight: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:69

Whether to highlight syntax using terminal colors.

Default

false

Inherited from

PrettyFormatOptions.highlight

---

indent

indent: number

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:74

Number of spaces to use for each level of indentation.

Default

2

Inherited from

PrettyFormatOptions.indent

---

maxDepth

maxDepth: number

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:79

Maximum depth to recurse into nested values.

Default

Infinity

Inherited from

PrettyFormatOptions.maxDepth

---

maxOutputLength

maxOutputLength: number

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:92

Approximate per-depth-level budget for output length. When the accumulated output at any single depth level exceeds this value, further nesting is collapsed. This is a heuristic safety valve, not a hard limit — total output can reach up to roughly maxDepth × maxOutputLength.

Default

1_000_000

Inherited from

PrettyFormatOptions.maxOutputLength

---

maxWidth

maxWidth: number

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:84

Maximum number of items to print in arrays, sets, maps, and similar collections.

Default

Infinity

Inherited from

PrettyFormatOptions.maxWidth

---

min

min: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:97

Whether to minimize added whitespace, including indentation and line breaks.

Default

false

Inherited from

PrettyFormatOptions.min

---

plugins

plugins: Plugins

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:121

Plugins used to serialize application-specific data types.

Default

[]

Inherited from

PrettyFormatOptions.plugins

---

printBasicPrototype

printBasicPrototype: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:102

Whether to print Object / Array prefixes for plain objects and arrays.

Default

true

Inherited from

PrettyFormatOptions.printBasicPrototype

---

printFunctionName

printFunctionName: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:107

Whether to include the function name when formatting functions.

Default

true

Inherited from

PrettyFormatOptions.printFunctionName

---

printShadowRoot

printShadowRoot: boolean

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:112

Whether to include shadow-root contents when formatting DOM nodes.

Default

true

Inherited from

PrettyFormatOptions.printShadowRoot

---

theme

theme: Theme

Defined in: node_modules/.pnpm/@vitest+pretty-format@4.1.10/node_modules/@vitest/pretty-format/dist/index.d.ts:46