typescript如何实现有条件的可选属性？

Question

interface Test {
    a?:boolean;
    b?:any
}

a、b默认都可选，但当a有值时，让b成为必填项。
应该如何实现？

Answer 1

type Test =  {
    a?:undefined;
    b?:any
} | {
    a: boolean;
    b: any
}

Answer 2

在 TypeScript 中，直接通过接口定义来实现条件性的可选属性（即一个属性的可选性依赖于另一个属性的存在与否）是不支持的。TypeScript 的类型系统是静态的，它在编译时就已经确定了类型，而无法根据运行时的值来动态地改变类型。

不过，你可以通过几种不同的策略来模拟这种行为：

1. 使用类型断言

虽然这不是类型安全的，但在运行时你可以通过类型断言来确保当 a 存在时 b 也存在。

interface Test {
    a?: boolean;
    b?: any;
}

function validateTest(obj: Test): Test {
    if (obj.a !== undefined && obj.b === undefined) {
        throw new Error("When 'a' is present, 'b' must also be present.");
    }
    return obj;
}

// 使用
const test: Test = { a: true }; // 编译时不会报错
validateTest(test); // 运行时抛出错误

const validTest: Test = { a: true, b: "something" }; // 正确

2. 使用联合类型

你可以定义两个接口，一个 a 不存在时 b 也不存在的接口，和另一个 a 存在时 b 也必须存在的接口。

interface TestWithoutA {
    a?: undefined;
    b?: undefined;
}

interface TestWithA {
    a: boolean;
    b: any;
}

type Test = TestWithoutA | TestWithA;

// 使用
const test1: Test = {}; // 正确
const test2: Test = { a: true, b: "something" }; // 正确
const test3: Test = { a: true }; // 错误，因为 b 不是可选的

但请注意，这种方法的缺点是 TypeScript 编译器不会强制在 a 存在时 b 也必须存在，只是定义了两种可能的形状。你需要通过额外的逻辑（如运行时检查）来确保 a 和 b 的一致性。

3. 使用高级类型技巧（如映射类型或条件类型）

对于更复杂的场景，你可以利用 TypeScript 的高级类型技巧来构建更复杂的类型定义，但这通常涉及到类型的递归或复杂的条件逻辑，可能会使代码难以理解和维护。

结论

由于 TypeScript 的静态类型特性，实现完全的条件性可选属性是不现实的。你通常需要通过运行时验证、联合类型或类型断言来模拟这种行为。选择哪种方法取决于你的具体需求和项目的复杂度。