Skip to content

Commit 7a5e665

Browse files
committed
docs: document new nameTemplate option
1 parent 6bfa3e6 commit 7a5e665

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

types/options.d.ts

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ export interface CompareSnapshotOptions {
77
* The name of the snapshots that will be generated
88
*/
99
name: string
10+
/**
11+
* The snapshot naming pattern using replaceable labels. All possible labels are: specName, givenName, browserName, width and height.
12+
* All labels in square brackets are replaced with actual values during runtime.
13+
* giveName is the name property above.
14+
* @default undefined
15+
* @example '[browserName]/[specName]-[givenName].[width]x[height]'
16+
*/
17+
nameTemplate?: string
1018
/**
1119
* A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
1220
* @default 0

0 commit comments

Comments
 (0)