fabric/vitest.d.ts

Object model for HTML5 canvas, and SVG-to-canvas parser. Backed by jsdom and node-canvas.

/* eslint-disable @typescript-eslint/no-empty-object-type -- augmenting vitest matchers */
import 'vitest';
import type { TMat2D } from './src/typedefs';
import type { cloneDeepWith } from 'es-toolkit/compat';
import type { FabricImage } from './src/shapes/Image';

type ObjectOptions<T = unknown> = ExtendedOptions<T> & {
  includeDefaultValues?: boolean;
};

type ExtendedOptions<T = unknown> = {
  cloneDeepWith?: Parameters<typeof cloneDeepWith<T>>[1];
} & object;

interface CustomMatchers<R = unknown, T = unknown> {
  toMatchSnapshot(propertiesOrHint?: ExtendedOptions<T>, hint?: string): R;

  toMatchObjectSnapshot(propertiesOrHint?: ObjectOptions<T>, hint?: string): R;

  toMatchSVGSnapshot(hint?: string): R;

  toEqualRoundedMatrix(expected: TMat2D, precision?: number): R;

  toEqualSVG(expected: string): void;

  toSameImageObject(expected: Partial<FabricImage>): void;
}

declare module 'vitest' {
  interface Assertion<T = any> extends CustomMatchers<T> {}
  interface AsymmetricMatchersContaining extends CustomMatchers {}
}