TypeScript动态类型赋值问题：消费代码类型不兼容的修复方案有哪些？

问题背景 #

无法修改外部文件otherfile.ts，该文件中SortOption接口的key字段被定义为string类型，但我们在consumer.ts中实现的getSortedAssetsByOrder函数要求传入keyof Asset类型的参数，导致调用时传入sortOption.key出现类型错误："Argument of type 'string' is not assignable to parameter of type 'keyof Asset'"。

以下是几种在consumer.ts中的修复方案：

方案一：使用类型断言快速兼容 #

直接通过类型断言将string类型的key转换为keyof Asset，适合能确保传入的key一定是Asset合法字段的场景：

修改getSortedAssetsByOrder函数：

//consumer.ts
//===========
import { Asset } from './otherfile';
import { sortBy } from "lodash";

export const getSortedAssetsByOrder = (
  assets: Asset[],
  key: string
) => {
    // 将key断言为Asset的键类型
    return sortBy(assets, (x) => x[key as keyof Asset]).reverse();
};

或者在调用函数时进行断言（如果调用处也有权修改）：

getSortedAssetsByOrder(assets, sortOption.key as keyof Asset);

方案二：添加运行时校验确保类型安全 #

定义合法的Asset键列表，在函数内部校验传入的key是否合法，避免运行时出错：

//consumer.ts
//===========
import { Asset } from './otherfile';
import { sortBy } from "lodash";

// 枚举Asset的所有合法键
const VALID_ASSET_KEYS = ['typename', 'updated_by', 'license_plate', 'length'] as const;
type ValidAssetKey = typeof VALID_ASSET_KEYS[number];

export const getSortedAssetsByOrder = (
  assets: Asset[],
  key: string
) => {
    // 运行时校验key的合法性
    if (!VALID_ASSET_KEYS.includes(key as ValidAssetKey)) {
        throw new Error(`不支持的排序键：${key}`);
    }
    return sortBy(assets, (x) => x[key as ValidAssetKey]).reverse();
};

方案三：重新定义SortOption类型约束 #

在consumer.ts中重新定义SortOption类型，将key字段限定为keyof Asset，同时将原SORT_OPTIONS断言为新类型（需确保原数据中的key都是合法的）：

//consumer.ts
//===========
import { sortBy } from "lodash";
import type { SortOption as OriginalSortOption, Asset } from './otherfile';
import { SORT_OPTIONS as OriginalSORT_OPTIONS } from './otherfile';

// 重新定义SortOption，覆盖key的类型
type SortOption = Omit<OriginalSortOption, 'key'> & { key: keyof Asset };

// 将原SORT_OPTIONS断言为新的类型
export const SORT_OPTIONS = OriginalSORT_OPTIONS as SortOption[];

export const getSortedAssetsByOrder = (
  assets: Asset[],
  key: keyof Asset
) => {
    return sortBy(assets, (x) => x[key]).reverse();
};

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