Skip to content

Commit

Permalink
docs: document new nameTemplate option
Browse files Browse the repository at this point in the history
  • Loading branch information
kien-ht committed Jul 25, 2024
1 parent 6bfa3e6 commit 7a5e665
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions types/options.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ export interface CompareSnapshotOptions {
* The name of the snapshots that will be generated
*/
name: string
/**
* The snapshot naming pattern using replaceable labels. All possible labels are: specName, givenName, browserName, width and height.
* All labels in square brackets are replaced with actual values during runtime.
* giveName is the name property above.
* @default undefined
* @example '[browserName]/[specName]-[givenName].[width]x[height]'
*/
nameTemplate?: string
/**
* A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
* @default 0
Expand Down

0 comments on commit 7a5e665

Please sign in to comment.