如何让TypeScript为类型推断字面量字符串而非通用string类型

代码示例 #

type Cardinality = 'many' | 'one';

type ValueType = 'string' | 'number';

interface ILinkDef<Source> {
  fwdCardinality: Cardinality;
  revNamespace: keyof Source;
  revCardinality: Cardinality;
  revLabel: string;
}

interface IAttrsDef {
  [label: string]: ValueType
}

interface ILinksDef<Source> {
  [label: string]: ILinkDef<Source>
}

interface ISchemaDef<Source> {
  [table: string]: {
    attrs: IAttrsDef;
    links: ILinksDef<Source>;
  };
}

class Schema<D extends ISchemaDef<any>> {
  defs: D
  constructor(
    defs: D,
  ) {
    this.defs = defs
  }
}

function schema<D extends ISchemaDef<D>>(defs: D) {
  return new Schema<D>(defs);
}

const s = schema({
  posts: {
    attrs: {
      title: 'string'
    },
    links: {
      owner: {
        fwdCardinality: 'one',
        revNamespace: 'users',
        revLabel: 'ownedPosts', 
        revCardinality: 'many'
      }      
    }
  },
  users: {
    attrs: {
      email: 'string'
    },
    links: {}
  }
})

type OwnerLink = typeof s.defs.posts.links.owner

问题现象 #

OwnerLink的推断结果如下，其中revLabel被自动拓宽为string类型，而非预期的字面量'ownedPosts'：

type OwnerLink = {
  fwdCardinality: "one";
  revNamespace: "users";
  revLabel: string;
  revCardinality: "many";
}

需求 #

希望revLabel能保留传入的字面量值类型，避免被拓宽为宽泛的string。

解决方案 #

核心思路是通过泛型捕获revLabel的具体字面量类型，阻止TypeScript自动拓宽类型。修改后的代码如下：

type Cardinality = 'many' | 'one';

type ValueType = 'string' | 'number';

// 新增RevLabel泛型参数，用于捕获revLabel的字面量类型
interface ILinkDef<Source, RevLabel extends string> {
  fwdCardinality: Cardinality;
  revNamespace: keyof Source;
  revCardinality: Cardinality;
  revLabel: RevLabel;
}

interface IAttrsDef {
  [label: string]: ValueType;
}

// 简化Schema类的泛型约束，保留类型推断自由度
class Schema<D> {
  defs: D;
  constructor(defs: D) {
    this.defs = defs;
  }
}

// 调整schema函数的泛型定义，精准约束结构同时保留字面量推断能力
function schema<D extends Record<string, { 
  attrs: Record<string, ValueType>; 
  links: Record<string, { 
    fwdCardinality: Cardinality; 
    revNamespace: keyof D; 
    revCardinality: Cardinality; 
    revLabel: string 
  }> 
}>>(defs: D) {
  return new Schema<D>(defs);
}

const s = schema({
  posts: {
    attrs: {
      title: 'string'
    },
    links: {
      owner: {
        fwdCardinality: 'one',
        revNamespace: 'users',
        revLabel: 'ownedPosts',
        revCardinality: 'many'
      }
    }
  },
  users: {
    attrs: {
      email: 'string'
    },
    links: {}
  }
});

type OwnerLink = typeof s.defs.posts.links.owner;
// 现在OwnerLink的revLabel类型为'ownedPosts'

修改说明 #

1. 给ILinkDef新增RevLabel泛型参数，明确约束其为字符串字面量类型，替代原来固定的string类型；
2. 简化Schema类的泛型约束，不再用ISchemaDef限制，让TypeScript能更自由地推断传入对象的完整类型；
3. 调整schema函数的泛型定义，精准约束传入参数的结构，同时保留对字面量类型的推断能力。

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