Skip to content

Open source CapCut alternative.

TypeScript
2.3 KB
Raw Blame
/**
 * Minimal typings for `bun:test`, covering what our unit tests use. The full
 * `@types/bun` package replaces ambient Node/DOM types project-wide (breaking
 * the Next.js server code), so the tests get this narrow shim instead.
 */
declare module "bun:test" {
  export function describe(label: string, fn: () => void): void;
  export interface TestFn {
    (label: string, fn: () => void | Promise<void>, timeoutMs?: number): void;
    skipIf(condition: boolean): TestFn;
  }
  export const test: TestFn;
  export function beforeAll(fn: () => void | Promise<void>): void;
  export function afterAll(fn: () => void | Promise<void>): void;
  export function beforeEach(fn: () => void | Promise<void>): void;
  export function afterEach(fn: () => void | Promise<void>): void;
  export interface Matchers {
    toBe(expected: unknown): void;
    toEqual(expected: unknown): void;
    toBeCloseTo(expected: number, precision?: number): void;
    toBeGreaterThan(expected: number): void;
    toBeGreaterThanOrEqual(expected: number): void;
    toBeLessThan(expected: number): void;
    toBeLessThanOrEqual(expected: number): void;
    toContain(expected: string): void;
    toMatch(expected: string | RegExp): void;
    toBeUndefined(): void;
    toBeDefined(): void;
    toBeNull(): void;
    toMatchObject(expected: object): void;
    toThrow(expected?: string | RegExp): void;
    rejects: Matchers;
    toHaveLength(expected: number): void;
    toHaveBeenCalled(): void;
    toBeTruthy(): void;
    toBeFalsy(): void;
    not: Matchers;
  }
  export function expect(value: unknown): Matchers;
  type Spy<T> = T extends (...args: infer Args) => infer Result ? {
    mock: { calls: Args[] };
    mockImplementation(fn: (...args: Args) => Result): Spy<T>;
    mockReturnValue(value: Result): Spy<T>;
    mockResolvedValue(value: Awaited<Result>): Spy<T>;
    mockRestore(): void;
  } : never;
  export function spyOn<T extends object, K extends keyof T>(object: T, method: K): Spy<T[K]>;
  /** Module mocking, for the tests that stand a dependency in. */
  export const mock: {
    <T extends (...args: never[]) => unknown>(fn: T): T & Spy<T>;
    module(specifier: string, factory: () => unknown): void;
  };
  /** Fake timers, for the tests that move the clock themselves. */
  export const jest: {
    useFakeTimers(): void;
    useRealTimers(): void;
    advanceTimersByTime(ms: number): void;
  };
}