@augment-vir/test
Version:
A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.
26 lines (25 loc) • 1.17 kB
TypeScript
import { type UniversalTestContext } from './universal-test-context.js';
/**
* An error that is thrown from {@link assertSnapshot} when the snapshot comparison fails due to the
* snapshot expectation file simply not existing.
*
* @category Test : Util
* @category Package : @augment-vir/test
* @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
*/
export declare class SnapshotFileMissingError extends Error {
constructor(testName: string);
}
/**
* Assert that the given snapshot data matches already-saved snapshot file's expectations. Note that
* the given data will be serialized into a JSON string if it is not already a string. This works in
* both Node and web tests.
*
* Web tests require a web-test-runner config with the `snapshotPlugin` plugin from
* `@virmator/test/dist/web-snapshot-plugin/web-snapshot-plugin.js` in order to work.
*
* @category Test
* @category Package : @augment-vir/test
* @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
*/
export declare function assertSnapshot(this: void, testContext: Readonly<UniversalTestContext>, data: unknown): Promise<void>;