在 TypeScript 中使用用户定义的对象作为类型

Question

我在这种情况下，我不知道类型会是什么样子，无论是未定义的还是布尔值、字符串还是数字等。我正在开发一个库，它将解析一些字符串内容并返回用户使用“类型对象”描述的属性对象。

Type 是类型对象应该是什么样子的接口，它是这样的：

/**
 * A type object.
 */
export default interface IType<O>
{
    /** The name of the type. */
    name: string;

    /** A description of the type. */
    description?: string;

    /**
     * Parse the given input content and return the parsed output value.
     * @param input The given input value.
     * @returns The parsed output.
     */
    parse(input: string): O;
}

我为用户提供了 3 个遵循此接口的预定义“类型对象”（Number 作为 numberType，Boolean 作为 booleanType，String 作为 stringType）。用户可以使用这些类型从字符串中收集参数。

参数接口定义了如何在代码中指定参数。

/**
 * An object describing how an argument will look like.
 */
export default interface IArg<T>
{
    /**
     * The name of the argument, this is how you use the argument later
     * in the command object.
     */
    name: string;

    /** A description about the argument. */
    description?: string;

    /** The type the argument should be resolved with. */
    type: IType<T>;

    /** Should this take all the parameters left of the string? */
    rest?: boolean;

    /** Is the argument required? */
    required?: boolean;
}

用户创建一个命令类并将一些参数传递给构造函数，包括一个参数数组；

[
    {
        name: "age"
        type: numberType
    },
    {
        name: "name",
        type: stringType
    }
]

解析命令字符串时，这些参数将被添加到对象input.args 中。不知何故，我希望打字稿解析器知道用户提供的信息可能提供或不提供什么。

例如如果需要一个参数并且是IArg<string> 的类型（我们称之为name），那么解析器知道input.args.name 肯定是一个字符串，但如果不需要，它可能是未定义的或字符串。

这有可能实现吗？

编辑：我找到了thisjcalz 的答案，它接受了一个键值对对象，这正是我正在寻找的；但我不确定如何用数组实现它。

Answer 1

这是我想出的：

首先从您的接口定义中删除required 参数。原因很快就会显现出来：

interface IArg<T> {
    /**
     * The name of the argument, this is how you use the argument later
     * in the command object.
     */
    name: string;

    /** A description about the argument. */
    description?: string;

    /** The type the argument should be resolved with. */
    argType: IType<T>;

    /** Should this take all the parameters left of the string? */
    rest?: boolean;
};

---

现在我使用这个人为设计的 token 解析器示例，它应该仅在需要或可用（即不为 null）时解析令牌。

// Used to check if the IArg has a required parameter that is set to true
function argIsRequired(arg: IArg<unknown> & {required?: boolean}): boolean {
    return arg.required === true;
}

function parseToken<T>(token: string, decodeToken: IArg<T> & { required: true }): T;
function parseToken<T>(token: string, decodeToken: IArg<T>): T | undefined;
function parseToken<T>(token: string | null, decodeToken: IArg<T>) {
    if (token == null) {
        if (argIsRequired(decodeToken)) {
            throw Error("required token not found");
        } else {
            return undefined;
        }
    }
    return decodeToken.argType.parse(token);
}

函数重载的目的是帮助类型检查器决定是否允许某些返回类型（T vs T | undefined）。

通过从IArg 接口中删除required 参数，我们现在可以在解析器函数中专门化它以充当函数的类型保护。

现在进行测试，我们定义了两个可能的参数，其中一个是必需的，另一个不是：

const ageArg = new class implements IArg<number> {
    readonly name = "age"
    readonly argType = numberType;
    readonly required = true;
};

const nameArg = new class implements IArg<string> {
    readonly name = "name"
    readonly argType = stringType;
};

如果上面的定义是正确的，如果我们尝试对上面parseToken函数返回的值使用错误的类型，类型检查器应该会给我们一个错误。

const age: number = parseToken('24', ageArg); // This is Ok
// const name: string = parseToken("", nameArg); // This gives error
const name: string | undefined = parseToken("", nameArg); // This is Ok

Playground link

Answer 2

经过大量的修补，我最终还是不知道该怎么做。 “The Programmer's Hangouts” discord 服务器上的某个天才花了大约 10 分钟，并借助我添加到我的帖子中的 SO 链接和他的一些聪明的想法解决了这个问题！

https://www.typescriptlang.org/play/index.html?ssl=1&ssc=1&pln=33&pc=1#code/C4TwDgpgBAggTgcygXigbynCBDAJgewDsAbEKQ7AWwgC4oBnYOAS0IQBpMcCSzRI6jFm05Y8RUlwCOAV2ZZcAfjoAjfPmI5CUAL4BuAFAGAxkUZRKIeAnoooAbQNRn6clVpQARADN5jAHLunpz8Hp5CrAjB0nIKdEwy0DrsTi4YFNR0ntgIENGhWYQylCoQcJ66BgC6UNi2poSMhgaswGXe2MbQACrgEACy2GDoqUUlZXRjpXCGzmoaWqrqmtiEs1AyhLgQvoQQuHSb27v76xFsgkyR6-gqAFYQxsB0tw9PUAA+5DLExIY6RlCUAA8vdHsAAGJwfCUAAiEHoxhYYGA+DgAB5ulAIAAPNpbWzWAB8qWcqG69k8GTyNVx+NwtnOCFJUEUUApnlCnlpeIgBKgAGsICB8N52X1BmAWWyOVhZPJ9tzsbz+QkINLXPYANJQVjsynU7lVOi9SCS+wcrlVGoAlxQOgYbW67Qcw3W5Tis1DC2Uq02lmTCAANzKAfIwbKzSBsOYERUMja6IAqsr6YTEES7Cm6XyGbBEKyQWCnlCYfDEcjURik5nAyGZoC+lAk4RmERuvgAJKENpwejgtuEZOZ1CpAAU2ZVedWZDZY4FdCTAEoUJmg-hmLh7eH6yuc-yx-O6KxvGUoJ2V8g1xvcCu2Z3t3t643IFAABpZ1vtrs9sr9p6DuiMZxgmEDomOoSihYViIPQS72FMZRVESRLNJowBQDidAfqgGC+H2wCBJkXgAFL4AAFoQ0Q5B4ABMACsuiGEAA