打字稿：函数类型声明中的无效参数类型

Question

我正在开始我的ts之旅，现在正在研究TypeGraphQL 。 我注意到一些我不理解和以前从未见过的东西：

export declare type ReturnTypeFunc = (returns?: void) => ReturnTypeFuncValue;

应该如何解释该类型？ 这个(returns?: void)代表什么？

Answer 1

ReturnTypeFunc类型在Query装饰器中使用：

export declare function Query(returnTypeFunc: ReturnTypeFunc, options?: AdvancedOptions): MethodDecorator;

Query装饰器通常是这样使用的：

  @Query(returns => [SampleObject])

据我所知，添加了returns参数以帮助提高可读性：此查询返回一个SampleObject数组。 如果删除类型ReturnTypeFunc中的returns参数，则不能再这样做，而必须改写@Query(() => [SampleObject]) 。

其他一些具有可选 void 参数的装饰器是：

@Resolver(of => Recipe) // This is a resolver for Recipe. See type ClassTypeResolver

@Field(type => [Rate]) // This field is of type Rate. See type ClassTypeResolver.

编辑：

1. 如评论中所述，您只能将null （如果未指定strictNullChecks ）或undefined分配给void类型的变量。
2. 提到的装饰器注释类。 graphql 模式是通过使用提供给装饰器的元数据生成的。 据我所知，您不应该定义类型为ReturnTypeFunc的函数。 这些参数是void类型的唯一原因是为了提高代码的可读性。

Answer 2

您描述的函数签名在这里，出于多种原因，可以编写void类型的可选参数的用法。

一个原因是作为一种防止调用者在正常情况下提供参数的方法，但允许内部库代码使用可能依赖于值的功能使用的未记录的内部逻辑。

这是一个非常人为的例子，演示了我上面描述的内容：

TS游乐场

function fn (param?: void): void {
  if ((param as any) === 'log a special message') {
    console.log('Internal behavior matched');
  }
};

fn(); // Ok
fn('hello'); // Not ok

/**
 * Written as returning void, but actually returns
 * something that is used for internal library behavior
 */
function internalFnForInteralThings (): void {
  return 'log a special message' as any;
};

fn(internalFnForInteralThings()); // Ok (and logs "Internal behavior matched")

最终，您必须检查导出该类型的项目的整个代码库，以了解它在每种情况下的使用方式，然后利用这些知识，您可以推断出作者选择以这种方式编写签名的原因。