数组的条件类型，在解构时提供错误或泛型

Question

在我的 Typescript 项目中，我有一个从函数返回的 Result 类型，其中包含错误或一些数据。它可以是[Error, null] 或[null, Data] 的任何一种形式。例如：

type Result<Data> = [ Error | null, Data | null ]

function randomSuccess(): Result<string> {
    if ( Math.random() > 0.5 ) {
        return [ null, 'success' ]
    else {
        return [ new Error( 'oh no' ), null ]
    }
}

const [ err, result ] = randomSuccess()
if ( err ) {
    .... // can now handle the extracted error and result

我希望 Typescript 检查错误或数据中只有一个不为空。例如：

    ...
        return [ new Error( 'oh no' ), 'success' ]

应该抛出一个错误。

我最初尝试为此编写类型是使用条件类型：

type Result<Data> = null extends Error ? [ null, Data ] : [ Error, null ]

当函数返回错误时，这编译得很好。然而，当返回有效数据时——例如return [ null, 'success' ]——编译器会抱怨：

类型“null”不可分配给类型“错误”

我想我理解编译器错误：在我的类型定义中Error 不是参数，所以null extends Error 将始终为假。但是我不知道从这里去哪里。

如何创建[Error, null] 或[null, Data] 的类型，而不是[Error, Data]？

Answer 1

您正在寻找一个union type，其中联合的部分是代表两种可能状态的两个元组（数组）：

type Result<Data> =
    [ null, Data ]      // Success
    |
    [ Error, null ];    // Failure

Result<Data> 可以任一有一种形式或另一种形式，但不能在两个地方都有null，也不能有Error, Data。 （也不能有 2 以外的长度。）

这是一个例子：

type Result<Data> =
    [ null, Data ]      // Success
    |
    [ Error, null ];    // Failure
    
function random(): Result<Date> {
//                        ^^^^−−−− Using `Date` for the `Data` type  argument
//                                just for example
    if (Math.random() < 0.5) {
        // Fail
        return [new Error(), null];
    }
    // Succeed
    return [null, new Date()];
}

const a = random();
if (a[0]) {
    // TypeScript now knows that `a[0]` is an `Error`
    console.log(`Error: ${a[0].message}`);
} else {
    // TypeScript now knows that `a[1]` is a `Date`
    console.log(`Success at ${a[1].toString()}`);
}

Playground link