Cypress Tips/Tricks - Typing Task Plugin Functions

index.d.ts

// Can import types from other files using TypeScript's typed imports functionality
type BlocksDto = import("../plugins/Suppressions/setup").BlocksDto;

// Or you can define the types here as well in this type definition file
type ApiHost = "https://staging.api.com" | "https://testing.api.com" | string;

declare namespace Cypress {
  interface Cypress {
    // ...environment variables
  }

  interface Chainable<Subject> {
    
    // ...custom commands
    
    task(
      event: 'teardownUnverifiedDomains',
      arg: {
        username: string;
        token: string;
      },
      options?: Partial<Loggable & Timeoutable>
    ): Chainable<boolean>;
    
    task(
      event: 'getBlocks',
      arg: { token: string; apiHost: ApiHost; limit: number },
      options?: Partial<Loggable & Timeoutable>
    ): Chainable<BlocksDto>;
  }
}