LMNR-AI TypeScript SDK 中类型导出的重要性与实践

在开发基于 TypeScript 的评估系统时，类型安全是保证代码质量的关键因素。LMNR-AI 的 TypeScript SDK 提供了一个强大的评估框架，但在实际使用中，开发者可能会遇到类型推导不足的问题。

问题背景

当使用 LMNR-AI SDK 创建评估函数时，常见的做法是将评估逻辑单独定义为一个函数，然后再传递给评估包装器。这种分离的写法虽然提高了代码的可读性和复用性，但却带来了类型信息丢失的问题。

例如，在文档示例中：

const evaluator = async (output, target) =>
    (await output) === target.capital ? 1 : 0

这里的 output 和 target 参数会被 TypeScript 推断为 any 类型，失去了类型检查的保护。

类型安全的解决方案

1. 内联函数写法

最简单的解决方案是将评估函数直接内联到评估包装器中：

evaluate({
    evaluators: { 
        checkCapitalCorrectness: async (output, target) =>
            (await output) === target.capital ? 1 : 0 
    }
})

这样 TypeScript 能够自动推导出参数的正确类型，无需额外类型注解。

2. 显式类型注解

对于更复杂的评估逻辑，可能需要单独定义函数。这时可以使用显式类型注解：

const evaluator = async (output: string, target: { capital: string }) =>
    (await output) === target.capital ? 1 : 0

3. 使用 SDK 提供的类型

更优雅的解决方案是 SDK 导出内部使用的类型定义，如 EvaluatorFunction，让开发者可以这样使用：

import { EvaluatorFunction } from 'lmnr-ai';

type MyOutput = string;
type MyTarget = { capital: string };

const evaluator: EvaluatorFunction<MyOutput, MyTarget> = async (output, target) =>
    (await output) === target.capital ? 1 : 0

这种方式既保持了代码的清晰分离，又获得了完整的类型安全。

最佳实践建议

1. 简单评估优先内联：对于简单的评估逻辑，优先使用内联函数写法，让 TypeScript 自动推导类型。

2. 复杂评估使用显式类型：当评估逻辑较复杂时，单独定义函数并使用 SDK 提供的类型或显式类型注解。

3. 保持文档示例类型安全：文档示例应展示类型安全的写法，避免让开发者复制粘贴后出现 any 类型的问题。

4. 充分利用泛型：评估系统通常涉及多种数据类型，合理使用泛型可以大大提高代码的复用性和类型安全性。

结论

类型安全是 TypeScript 的核心价值之一。通过合理使用内联函数、显式类型注解和 SDK 提供的类型定义，开发者可以在 LMNR-AI 评估系统中构建既安全又易于维护的代码。SDK 维护者也应确保导出所有必要的中间类型，为开发者提供完整的类型支持。