Documentation
On this page

Function · Devtools

assertHeadlessSnapshot

Compares a headless rendering with a stored snapshot, optionally updating it.

@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43

Signature

TypeScript
assertHeadlessSnapshot(path: string, update: boolean = false): string

Parameters

NameTypeDescription
pathstringStored snapshot path.
updateboolean
Default: false
Whether a missing or changed snapshot should be replaced.

Returns

string — The resolved snapshot path after comparison or update.

Source

SharpTS.Gui.Sdk/GuiPackage/devtools.ts:86 at SharpTS revision 7c6010104a43c34d80e9d44704cf179bc4f5b8e0.