@lewiswright/storybook-addon-vis/dist/index.d.ts

Storybook Vitest visual testing addon

import './matcher.js';
export * from 'vitest-plugin-vis';
import { ComparisonMethod, ToMatchImageSnapshotOptions, AutoSnapshotOptions, ImageSnapshotTimeoutOptions, ImageSnapshotAnimationOptions, ImageSnapshotIdOptions, SsimComparisonOptions, PixelComparisonOptions, FailureThresholdOptions } from 'vitest-plugin-vis/client';
export { AutoSnapshotOptions, ComparisonMethod, FailureThresholdOptions, ImageSnapshotAnimationOptions, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions, ToMatchImageSnapshotOptions } from 'vitest-plugin-vis/client';

/**
 * Define snapshot parameter for auto snapshot.
 */
declare function defineAutoSnapshotParam<M extends ComparisonMethod>(snapshot: ToMatchImageSnapshotOptions<M> & AutoSnapshotOptions): {
    snapshot: ImageSnapshotTimeoutOptions & ImageSnapshotAnimationOptions & ImageSnapshotIdOptions & (M extends "ssim" ? SsimComparisonOptions<M> : PixelComparisonOptions<M>) & FailureThresholdOptions & {
        expectToFail?: boolean | undefined;
    } & AutoSnapshotOptions;
};
declare function isSnapshotEnabled(tags: string[]): boolean;

/**
 * Check if the snapshot image exists.
 */
declare function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined): false | Promise<boolean>;

export { defineAutoSnapshotParam, hasImageSnapshot, isSnapshotEnabled };