TypeScript如何定义含固定异类型键且允许任意指定值类型键的对象

问题原因 #

你当前写法报错的核心是类型冲突：TaxonomyData的索引签名要求所有字符串键的值都必须是string[]类型，将它和{kind: 'content'}做交叉类型时，kind的值是字符串类型的'content'，和string[]类型不兼容，最终FrontmatterContent会被推导为never类型，自然无法正常赋值。

解决方案 #

方案1：兼容索引签名+校验函数（推荐） #

兼顾使用便捷性和严格类型安全，适合绝大多数场景：

type TaxonomyTerms = string[]

interface FrontmatterContent {
  kind: 'content'
  // 索引签名兼容kind的特殊值，其他字段自动限制为string[]
  [key: string]: TaxonomyTerms | 'content'
}

interface FrontmatterTaxonomy {
  kind: 'taxonomy'
  taxonomyName: string
}

type Frontmatter = FrontmatterContent | FrontmatterTaxonomy

// 轻量辅助函数，不用额外写类型标注也能自动校验
function defineFrontmatter<T extends Frontmatter>(fm: T): T {
  return fm
}

// 正常赋值无报错
const fm1 = defineFrontmatter({
  kind: 'content',
  tags: ['foo', 'bar']
})

const fm2 = defineFrontmatter({
  kind: 'taxonomy',
  taxonomyName: 'categories'
})

// 错误场景会被自动拦截：比如给非kind字段赋值非string[]类型
// const fm3 = defineFrontmatter({
//   kind: 'content',
//   tags: [1, 2] // 会提示类型错误
// })

方案2：映射类型规避冲突 #

如果不想额外加辅助函数，也可以用映射类型避开kind和索引签名的冲突，适合TypeScript 4.9及以上版本：

type TaxonomyTerms = string[]
// 定义除kind外的任意字符串键值都是string[]
type TaxonomyData = { [key: string]: string[] } & { kind?: never }

type FrontmatterContent = TaxonomyData & {
  kind: 'content'
}

interface FrontmatterTaxonomy {
  kind: 'taxonomy'
  taxonomyName: string
}

type Frontmatter = FrontmatterContent | FrontmatterTaxonomy

// 直接赋值不会报错
const fm1: Frontmatter = {
  kind: 'content',
  tags: ['foo', 'bar']
}

const fm2: Frontmatter = {
  kind: 'taxonomy',
  taxonomyName: 'categories'
}

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