在 Typescript 中读取强类型 yaml 文件？

Question

我有以下yaml文件：

trainingPhrases:
- help me
- what to do
- how to play
- help

我使用来自 node 的readFile从磁盘读取它并使用来自js-yaml load解析它：

import { load } from "js-yaml";
import { readFile } from "fs/promises";

const phrases = load(await readFile(filepath, "utf8")).trainingPhrases as string[];

我收到以下eslint警告：

ESLint: Unsafe member access .trainingPhrases on an any value.(@typescript-eslint/no-unsafe-member-access)

我不想抑制警告，而是想将它映射到 YAML 文件的具体类型（就像在 axios 中发生的那样： axios.get<MyResponseInterface>(...) - 执行GET并且MyResponseInterface定义了HTTP 响应）。

有专门的图书馆吗？

Answer 1

从我在使用@types/js-yaml时可以看到的是load不是通用的，这意味着它不接受类型参数。

所以在这里获取类型的唯一方法是使用断言，例如：

const yaml = load(await readFile(filepath, "utf8")) as YourType;
const phrases = yaml.trainingPhrases;

或者简而言之：

const phrases = (load(await readFile(filepath, "utf8")) as YourType).trainingPhrases;

---

如果你绝对想要一个泛型函数，你可以很容易地包装原始函数，例如：

import {load as original} from 'js-yaml';

export const load = <T = ReturnType<typeof original>>(...args: Parameters<typeof original>): T => load(...args);

然后你可以将它用作：

const phrases = load<YourType>('....').trainingPhrases;