gherkin-testcafe/index.d.ts

> Run TestCafé tests with the Gherkin syntax

declare module 'gherkin-testcafe' {
  global {
    interface GherkinTestcafeRunner extends Runner {
      tags(tags: string[]): GherkinTestcafeRunner;
      parameterTypeRegistryFile(path: string): GherkinTestcafeRunner;
      dryRun(enabled: boolean): GherkinTestcafeRunner;
    }

    interface GherkinTestCafe extends TestCafe {
      /**
       * Creates the test runner that is used to configure and launch test tasks.
       */
      createRunner(): GherkinTestcafeRunner;

      /**
       * Creates the live mode test runner that is used to configure and launch test tasks.
       */
      createLiveModeRunner(): GherkinTestcafeRunner;

      /**
       * Contains the URL of TestCafe for remote access
       */
      browserConnectionGateway: { connectUrl: string };
    }

    interface GherkinTestCafeFactory extends TestCafeFactory {
      (
        hostname?: string,
        port1?: number,
        port2?: number,
        sslOptions?: TlsOptions,
        developmentMode?: boolean
      ): Promise<GherkinTestCafe>;
    }

    interface TestController {
      testRun: {
        test: {
          name: string;
          meta: Record<string, string>;
          fixture: {
            name: string;
            meta: Record<string, string>;
          };
        };
        /**
         * Shared between all the tests of a given feature - use carefully as sharing data between
         * tests goes against the isolation principle
         */
        fixtureCtx: Record<string, any>;
      };
    }
  }

  const createTestCafe: GherkinTestCafeFactory;

  export * from 'testcafe';
  export default createTestCafe;
}

declare module '@cucumber/cucumber' {
  import { t } from 'testcafe';

  export interface DataTable {
    /** Returns the table as a 2-D array. */
    raw(): string[][];

    /** Returns the table as a 2-D array, without the first row. */
    rows(): string[][];

    /** Returns an object where each row corresponds to an entry (first column is the key, second column is the value). */
    rowsHash(): { [firstCol: string]: string };

    /** Returns an array of objects where each row is converted to an object (column header is the key). */
    hashes(): Array<{ [colName: string]: string }>;

    /** Returns a new instance with the data transposed */
    transpose(): DataTable;
  }

  export type TestHookFunction = (testController: typeof t) => Promise<void>;
  export type GlobalHookFunction = (
    fixtureContext: { [key: string]: any },
    fixtureMeta: Record<string, string>
  ) => Promise<void>;

  export function After(code: TestHookFunction): void;
  export function After(options: string, code: TestHookFunction): void;
  export function AfterAll(code: GlobalHookFunction): void;
  export function Before(code: TestHookFunction): void;
  export function Before(options: string, code: TestHookFunction): void;
  export function BeforeAll(code: GlobalHookFunction): void;

  export type StepFunction = (
    testController: typeof t,
    parameters: any[],
    dataTable: DataTable | null,
    docString: string | null
  ) => Promise<void>;

  export function Given(pattern: RegExp | string, code: StepFunction): void;
  export function When(pattern: RegExp | string, code: StepFunction): void;
  export function Then(pattern: RegExp | string, code: StepFunction): void;
}