Question

我有一个通用接口，其中T扩展了boolean。如果T扩展了true，则我希望一个属性存在，否则，我不希望它存在。该接口扩展了另一个接口，因此我不能使用一种类型，并且我不想使用多个接口和一个联合类型。

我曾希望never能解决我的难题。

interface MyInterface<T extends boolean> extends MyOtherInterface {
    someProp: string;
    conditionalProp: T extends true ? number : never;
}

const cTrue: MyInterface<true> = {
    firstProp: 1,
    someProp: 'foo',
    conditionalProp: 1
  },
  cFalse: MyInterface<false> = { // fails for missing conditionalProp: never
    firstProp: 2,
    someProp: 'bar'
  },
  cAnyTrue: MyInterface<any> = {
    firstProp: 3,
    someProp: 'baz',
    conditionalProp: 3
  },
  cAnyFalse: MyInterface<any> = { // fails for missing conditionalProp: never
    firstProp: 4,
    someProp: 'baz'
  };

我也尝试同时使用void和undefined。在所有三种情况下，当我实例化MyInterface<false>时，都需要设置conditionalProp。在第一种情况下，由于类型为never，我可以将其分配为任何内容。

就像我之前暗示的那样，有一个冗长的解决方法。

interface MyInterfaceTrue extends MyOtherInterface {
    someProp: string;
    conditionalProp: number;
}

interface MyInterfaceFalse extends MyOtherInterface {
    someProp: string;
}

type MyInterface<T extends boolean> = T extends true ? MyInterfaceTrue : MyInterfaceFalse;

这里是TypeScript Playground。

Answer 1

解决方法

// The definition of the type with all the properties
interface _Data {
  always: number;
  sometimes: string;
}

// Conditionally exclude the properties if "true" or "false" was passed.
type Data<T extends boolean> = T extends true ? Omit<_Data, "sometimes"> : _Data;

/*
 * Tests
 */

const forTrue: Data<true> = {
  always: 0,
  // sometimes: "" => Error
};

const forFalse: Data<false> = {
  always: 0,
  sometimes: ""
}

此解决方案使用typedef，但您几乎可以互换使用类型和接口。

使事情变得更好

为了使整个过程更好用，我建议将“有条件地提取属性”的过程提取为一个可重用的单独类型。

type ConditionallyOmit<Condition extends boolean, T, K extends keyof T> = Condition extends true ? Omit<T, K> : T;

然后您可以这样使用：

type Data<T extends boolean> = ConditionallyOmit<T, _Data, "sometimes">

您当然可以内联原始定义：

type Data<T extends boolean> = ConditionallyOmit<T, {
  always: number;
  sometimes: string;
}, "sometimes">

将其设为DRY

为什么需要其他类型。

我很确定您目前只能使用一个界面来完成此操作。

我当时正在考虑通过扩展有条件地包括类型或{}的类型来解决这个问题-与此类似：

type TrueOrEmpty<Condition extends boolean, T> = Condition extends true ? {} : T;

这将为您提供T或{}，因此它将有条件地添加{}，该菜单什么都不做，或者包含您希望包含在其中的属性-取决于关于您传递的内容。

然后我将使用它来扩展接口，例如：

interface Data<T extends boolean>
  // Properties you only want when you pass true
  extends TrueOrEmpty<T, { sometimes: string }>
{
    // Properties you always want to have
    always: number
}

但这会给您以下错误：

An interface can only extend an object type or intersection of object types with statically known members.

并且无法解决该错误：Typescript无法知道静态包含什么内容，因此它不允许这样做。

TypeScript通用接口，仅具有使用某些模板参数值定义的属性

1 个答案:

解决方法

使事情变得更好

为什么需要其他类型。