使用TypeScript扩展Cypress.config自定义属性的方法

我尝试通过以下代码扩展Cypress配置并添加自定义属性：

Cypress.Commands.overwrite('getUser', (originalFn: any) => {
    const overwriteOptions = {
        accountPath: `accounts/${options.accountPath}`,
    };

    return originalFn(overwriteOptions).then(response =>
        Cypress.config({
            authUserString: generateAuthUserString(response.email, response.password),
        })
    );
});

但出现如下TypeScript错误：

No overload matches this call.
  Overload 1 of 4, '(key: "url" | "browser" | "autoOpen" | "browserUrl" | "clientRoute" | "cypressEnv" | "isNewProject" | "isTextTerminal" | "morgan" | "parentTestsFolder" | "parentTestsFolderDisplay" | ... 84 more ... | "cypressBinaryRoot"): string | ... 16 more ... | { ...; }', gave the following error.
    Argument of type '{ authUserString: any; }' is not assignable to parameter of type '"url" | "browser" | "autoOpen" | "browserUrl" | "clientRoute" | "cypressEnv" | "isNewProject" | "isTextTerminal" | "morgan" | "parentTestsFolder" | "parentTestsFolderDisplay" | ... 84 more ... | "cypressBinaryRoot"'.
  Overload 2 of 4, '(Object: TestConfigOverrides): void', gave the following error.
    Argument of type '{ authUserString: any; }' is not assignable to parameter of type 'TestConfigOverrides'.
      Object literal may only specify known properties, and 'authUserString' does not exist in type 'TestConfigOverrides'.ts(2769)

1. 扩展Cypress配置的TypeScript类型 #

在项目的cypress/support/index.d.ts（若不存在则新建）文件中添加类型声明扩展，让TypeScript识别自定义配置属性：

declare namespace Cypress {
  interface ConfigOptions {
    // 定义自定义属性，可添加类型约束
    authUserString?: string;
  }
}

2. 修正命令重写中的变量缺失问题 #

原代码中options变量未被传入，需要在overwrite方法的参数中接收：

Cypress.Commands.overwrite('getUser', (originalFn: any, options: any) => {
    const overwriteOptions = {
        accountPath: `accounts/${options.accountPath}`,
    };

    return originalFn(overwriteOptions).then(response =>
        Cypress.config({
            authUserString: generateAuthUserString(response.email, response.password),
        })
    );
});

3. 确保类型声明文件被编译器识别 #

检查项目根目录的tsconfig.json，确保类型声明文件被包含在编译范围内：

{
  "include": [
    "cypress/**/*.ts",
    "cypress/support/index.d.ts"
  ]
}

内容的提问来源于stack exchange，提问作者Maciek