Class SnapshotPlugin

constructor

• new SnapshotPlugin(t: TestBase, opts: SnapshotOptions): SnapshotPlugin

  Parameters

  • t: TestBase
  • opts: SnapshotOptions

  Returns SnapshotPlugin

writeSnapshot

cleanSnapshot

• get cleanSnapshot(): undefined | ((snapshotData: string) => string)

  Method that will be called on snapshot strings. This can be used to remove transient run-specific data from snapshots using simple string transforms.

  Returns undefined | ((snapshotData: string) => string)

• set cleanSnapshot(clean: undefined | ((snapshotData: string) => string)): void

  Parameters

  • clean: undefined | ((snapshotData: string) => string)

  Returns void

compareOptions

• get compareOptions(): CompareOptions

  Options that will be used when formatting snapshots and diffing/comparing objects using any assertion methods.

  Returns CompareOptions

• set compareOptions(cmt: CompareOptions): void

  Parameters

  • cmt: CompareOptions

  Returns void

formatSnapshot

• get formatSnapshot(): undefined | ((obj: any) => any)

  Function that turns an object into a snapshot string.

  By default tcompare!format is used. If a string is returned, then that string is the snapshot string. If any other type is returned, then the returned value will be formatted using tcompare!format.

  Returns undefined | ((obj: any) => any)

• set formatSnapshot(format: undefined | ((obj: any) => any)): void

  Parameters

  • format: undefined | ((obj: any) => any)

  Returns void

snapshotFile

• get snapshotFile(): string

  The file where snapshots will be written to and read from

  Returns string

• set snapshotFile(f: string | URL): void

  Parameters

  • f: string | URL

  Returns void

matchSnapshot

• matchSnapshot(found: any, ...__namedParameters: MessageExtra): boolean

  In --snapshot mode, takes a snapshot of the object provided, and writes to the snapshot file.

  Otherwise, reads the snapshot file, and verifies that a snapshot of the object provided matches the stored snapshot.

  Parameters

  • found: any
  • ...__namedParameters: MessageExtra

  Returns boolean

resolveMatchSnapshot

• resolveMatchSnapshot<T extends unknown = any>(
      fnOrPromise: Promise<T> | (() => Promise<T>),
      ...__namedParameters: MessageExtra,
  ): Promise<boolean>

  Resolve a promise, and verify that the resulting value matches the snapshot.

  Type Parameters

  • T extends unknown = any

  Parameters

  • fnOrPromise: Promise<T> | (() => Promise<T>)
  • ...__namedParameters: MessageExtra

  Returns Promise<boolean>