TypeScript：基于布尔选项参数的返回类型缩小

我正在尝试为我的函数创建一个类型，以便返回类型根据传递给它的值而变化。我考虑过Typescript 返回类型取决于参数接下来（几乎）这封信似乎效果很好。 然而，在我的项目中，我必须使用箭头函数。另外，如果可能的话，我想避免过载。考虑这个签名和实现：

type CreateDocumentListOptions = {
  withVersions?: boolean;
};

type CreateDocumentList = (
  options?: CreateDocumentListOptions
) => CreateDocumentListOptions["withVersions"] extends true
  ? DocumentWithVersions[]
  : Document[];

const createDocumentList: CreateDocumentList = ({
  withVersions = false
} = {}) =>
  times(
    withVersions ? createDocumentWithVersions : createDocument,
    chance.natural({ min: 1, max: 10 })
  );

当我这样调用该函数时：

const documentList: DocumentWithVersions[] = createDocumentList({
  withVersions: true
});

正如 TS 所认为的，我发现类型不匹配createDocumentList返回一个Document[]不是想要的DocumentWithVersions[]。我的印象是，使用三元运算符足以让 TS 理解返回类型会根据其条件而改变。

For the complete editable example:

如果您放弃重载，但仍然想要一个根据参数切换的返回类型，那么您将需要使用generic函数返回一个条件类型。例如：

type CreateDocumentList = <B extends boolean = false>(
    options?: { withVersions?: B }
) => B extends true
    ? DocumentWithVersions[]
    : Document[];

这里是泛型类型参数B is 受约束的 to boolean and defaults to false。然后，取决于是否B is true or false，输出是DocumentWithVersions[] or Document[].

返回条件类型的泛型函数的一个警告是，在函数的实现内部，编译器无法验证您所做的事情是否安全。在哪里B是一个未指定的泛型，编译器defers评估B extends true ? ...，这意味着它无法看到任何特定值何时与类型匹配。这个痛点是公开问题的主题微软/TypeScript#33912.

const createDocumentListOops: CreateDocumentList = (({
    withVersions = false
} = {}) =>
    times(
        withVersions ? createDocumentWithVersions : createDocument,
        chance.natural({ min: 1, max: 10 })
    )); // error!
// Type 'Document[]' is not assignable to type 
// 'B extends true ? Required<Document>[] : Document[]'

除非采取任何措施来解决这个问题，否则这意味着您将需要使用类型断言或类似的方法以避免实现中的编译器错误：

const createDocumentList = (({
    withVersions = false
} = {}) =>
    times(
        withVersions ? createDocumentWithVersions : createDocument,
        chance.natural({ min: 1, max: 10 })
    )) as CreateDocumentList; // okay

现在我们可以测试调用createDocumentList()按照你的意愿行事：

const documentList = createDocumentList({ withVersions: true });
// const documentWithVersionsList: Required<Document>[]

const documentList1 = createDocumentList();
// const documentList1: Document[]

const documentList2 = createDocumentList({ withVersions: false });
// const documentList2: Document[]

const documentList3 = createDocumentList({ withVersions: Math.random() < 0.5 });
// const documentList3: Document[] | Required<Document>[]

看起来不错。注意documentList3 is a union的类型，因为withVersions输入的属性是boolean，这是并集true | false，以及返回类型createDocumentList() is 分配性的超过工会。这可能是也可能不是您想要的行为，但在我看来这是合理的。

Playground 代码链接