Typescript Interface – Possible to make “one or the other” properties required?

by

If you’re truly after “one property or the other” and not both you can use never in the extending type:

interface MessageBasics {
  timestamp?: number;
  /* more general properties here */
}
interface MessageWithText extends MessageBasics {
  text: string;
  attachment?: never;
}
interface MessageWithAttachment extends MessageBasics {
  text?: never;
  attachment: string;
}
type Message = MessageWithText | MessageWithAttachment;

// 👍 OK 
let foo: Message = {attachment: 'a'}

// 👍 OK
let bar: Message = {text: 'b'}

// ❌ ERROR: Type '{ attachment: string; text: string; }' is not assignable to type 'Message'.
let baz: Message = {attachment: 'a', text: 'b'}

Example in Playground

More Related Contents:

  1. Create a global variable in TypeScript
  2. How to use jQuery with TypeScript
  3. Way to tell TypeScript compiler Array.prototype.filter removes certain types from an array?
  4. Type definition in object literal in TypeScript
  5. Difference between Variance, Covariance, Contravariance and Bivariance in TypeScript
  6. What does the “as const” mean in TypeScript and what is its use case?
  7. How do I declare object value type without declaring key type?
  8. How to use fetch in TypeScript
  9. Typescript property does not exist on union type
  10. Typescript primitive types: any difference between the types “number” and “Number” (is TSC case-insensitive)?
  11. Specify method’s type without converting the method to property
  12. Is it possible to restrict number to a certain range
  13. ESLint – Configuring “no-unused-vars” for TypeScript
  14. Keyof inferring string | number when key is only a string
  15. Object destructuring with property names that are not valid variable names
  16. Function property vs method
  17. How to declare a type as nullable in TypeScript?
  18. How to use Object.values with typescript?
  19. is there a way to get all required properties of a typescript object
  20. Typescript: ReturnType of overloaded function
  21. What TypeScript version is Visual Studio Code using? How to update it?
  22. Why does TypeScript track mutation of function static properties?
  23. Array VS Type[] in Typescript
  24. TypeScript filter out nulls from an array
  25. typescript: validate excess keys on value, returned from function
  26. How to use array.map with tuples in typescript?
  27. Typescript: Omit a property from all interfaces in a union, but keep the union structure
  28. Declaring abstract method in TypeScript
  29. how to remove properties via mapped type in TypeScript
  30. What is a TypeScript Map file?

Leave a Comment