如何限制TypeScript编写的Cypress自定义命令的参数仅接受指定值？

你可以通过编译期类型约束+运行时校验的组合方案实现参数限制，兼顾开发效率和运行稳定性：

1. 编译期类型约束（TypeScript项目适用） #

将参数的类型从通用string修改为固定值的联合类型，开发阶段传错参数时IDE会直接标错提示，提前拦截问题。

2. 运行时参数校验 #

所有项目都可以加这层兜底校验，命令执行前先判断参数是否符合要求，不符合就直接抛出明确的错误提示，避免后续执行出现无意义的异常。

TypeScript项目完整代码： #

// 统一维护允许的参数值，后续修改只需要调整这一处
const ALLOWED_COLUMN_NAMES = ['xxx', 'yyy', 'zzz'] as const
type AllowedColumn = typeof ALLOWED_COLUMN_NAMES[number]

Cypress.Commands.add('addColumnAsDimension', (columnName: AllowedColumn) => {
  // 运行时校验逻辑
  if (!ALLOWED_COLUMN_NAMES.includes(columnName)) {
    throw new Error(`addColumnAsDimension 仅支持传入以下参数值：${ALLOWED_COLUMN_NAMES.join('、')}，实际传入值为：${columnName}`)
  }

  // 原有业务逻辑保持不变
  chartMenu.addColumnButton.click();
  chartMenu.columnNameButton(columnName).click();
  chartMenu.addAsDimensionButton.click();
});

纯JS项目简化版本： #

const ALLOWED_COLUMN_NAMES = ['xxx', 'yyy', 'zzz']

Cypress.Commands.add('addColumnAsDimension', (columnName) => {
  if (!ALLOWED_COLUMN_NAMES.includes(columnName)) {
    throw new Error(`addColumnAsDimension 仅支持传入以下参数值：${ALLOWED_COLUMN_NAMES.join('、')}，实际传入值为：${columnName}`)
  }

  chartMenu.addColumnButton.click();
  chartMenu.columnNameButton(columnName).click();
  chartMenu.addAsDimensionButton.click();
});

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