从 TypeScript 中的依赖项访问类型声明

Question

这里是 arg 的类型，Node.js 控制台命令解析器：

declare const flagSymbol: unique symbol;

declare function arg<T extends arg.Spec>(spec: T, options?: arg.Options): arg.Result<T>;

declare namespace arg {
    export function flag<T>(fn: T): T & { [flagSymbol]: true };

    export const COUNT: Handler<number> & { [flagSymbol]: true };

    export type Handler <T = any> = (value: string, name: string, previousValue?: T) => T;

    export interface Spec {
        [key: string]: string | Handler | [Handler];
    }

    export type Result<T extends Spec> = { _: string[] } & {
        [K in keyof T]?: T[K] extends Handler
            ? ReturnType<T[K]>
            : T[K] extends [Handler]
            ? Array<ReturnType<T[K][0]>>
            : never
    };

    export interface Options {
        argv?: string[];
        permissive?: boolean;
        stopAtPositional?: boolean;
    }
}

export = arg;

我需要注释解析结果：

import parseConsoleArgument from 'arg';

export function cli(rawConsoleCommandData: Array<string>): void {
  const consoleCommandArguments: /* ??? */ = parseConsoleArgument(
      {}, { argv: rawConsoleCommandData.slice(2)}
  );
}

逻辑正确的类型是arg.Result。但是，我无法访问它。下面的代码

import parseConsoleArgument from 'arg';

export function cli(rawConsoleCommandData: Array<string>): void {
  const consoleCommandArguments: arg.Result = parseConsoleArgument(
      {}, { argv: rawConsoleCommandData.slice(2)}
  );
}

给TS2503: Cannot find namespace "arg"。

Answer 1

不确定为什么要注释变量，其类型将根据parseConsoleArgument 的结果推断。所以它已经是合适的类型了。如果您的团队需要对所有变量进行注释，您应该挑战 IMO，有很多类型很难在不复制大量代码的情况下进行注释。这是其中一种情况，让我们看看为什么。

访问Result 不是问题，您只是不通过arg 命名空间访问它，您需要通过您使用的模块别名访问它：

const consoleCommandArguments: parseConsoleArgument.Result<{}> = parseConsoleArgument(
    {}, { argv: rawConsoleCommandData.slice(2)}
);

这行得通，但你看到你有一个 parseConsoleArgument.Result 的类型参数，我使用了 {} 。在您开始添加要解析的参数之前，这似乎不是问题：

export function cli(rawConsoleCommandData: Array<string>): void {
  const consoleCommandArguments: parseConsoleArgument.Result<{}> = parseConsoleArgument(
      { p: Number, p2: Boolean }, { argv: rawConsoleCommandData.slice(2)}
  );
  consoleCommandArguments.p // err
}

如果我们删除显式注释，我们不会收到错误，并且p 是number，正如人们所期望的那样。这是因为parseConsoleArgument 是一个通用函数，它从它的第一个参数中提取类型信息并使用条件类型来创建一个具有{ p: number, p2: Boolean } 的新类型

如果我们想手动输入，我们需要写：

export function cli(rawConsoleCommandData: Array<string>): void {
  const consoleCommandArguments : parseConsoleArgument.Result<{
    p: typeof Number,
    p2: typeof Boolean
  }> = parseConsoleArgument(
      { p: Number, p2: Boolean }, { argv: rawConsoleCommandData.slice(2)}
  );
  consoleCommandArguments.p // ok
}

这很有效，但比原来的要长得多（不必要），并且需要我们更改两个位置以添加新参数。我会让编译器推断类型，它非常擅长。任何想要查看实际类型的人只需将鼠标悬停在变量上，他们就会在工具提示中看到类型