Documentation
On this page

Function · Devtools

assertHeadlessSnapshot

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

@sharpts/gui · SharpTS 572a2e31be0e

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

src/SharpTS.Gui.Sdk/GuiPackage/devtools.ts:86 at SharpTS revision 572a2e31be0e2a09be0138bc44501b34d6245b51.