Skip to content

Interface: CellSnapshotMatcherOptions

@termwright/test


@termwright/test / CellSnapshotMatcherOptions

Defined in: test/src/matchers.ts:71

Options for TermwrightMatchers.toMatchCellSnapshot.

readonly optional attributes?: boolean

Defined in: test/src/cells.ts:16

Append the styled-run legend. Default false.

CellSnapshotOptions.attributes


readonly optional box?: boolean

Defined in: test/src/cells.ts:18

Draw the frame with the viewport size. Default true.

CellSnapshotOptions.box


readonly optional palette?: ColorPalette

Defined in: test/src/cells.ts:22

Names palette colors in the legend, so CI and laptop agree.

CellSnapshotOptions.palette


readonly optional timeout?: number

Defined in: test/src/matchers.ts:57

Milliseconds to keep re-probing. Defaults to the expect timeout class.

PollOptions.timeout


readonly optional trimTrailingRows?: boolean

Defined in: test/src/cells.ts:20

Drop empty rows at the bottom of the viewport. Default true.

CellSnapshotOptions.trimTrailingRows