Type union not checking for excess properties

by

This is a bit of a quirk in how unions work in conjunction with excess property checks. {A:1, C: 3} is actually compatible with {C: number} except for excess property checks:

const o = {A:1, C: 3};
const ok: {C: number} = o; // No direct literal assignment, no excess property checks
const nok: {C: number} = { A:1, C: 3}; // Excess property checks kick in

Playground Link

And the quirk of excess property checks is that for unions, it allows any property from any union constituent to be present in the assigned object literal.

You can get an error if the union constituents are incompatible one with another:

type T =  {A: number, B: number} | {C: number, A?: undefined, B?: undefined };

const valid: T = {A: 1, B: 2};
const alsoValid: T = {C: 3};

// Error
const invalid: T  = {A: 1, B: 2, C: 3};
//Error
const alsoInvalid: T = {A:1, C: 3};

Playground Link

You can also use the StrictUnion from here if the union has a lot of memebers


type UnionKeys<T> = T extends T ? keyof T : never;
type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never;
type StrictUnion<T> = StrictUnionHelper<T, T>

type T =  StrictUnion<{A: number, B: number} | {C: number }>;

const valid: T = {A: 1, B: 2};
const alsoValid: T = {C: 3};

// Error
const invalid: T  = {A: 1, B: 2, C: 3};
//Error
const alsoInvalid: T = {A:1, C: 3};

Playground Link

More Related Contents:

  1. Is there a `valueof` similar to `keyof` in TypeScript?
  2. Angular 2 @ViewChild annotation returns undefined
  3. TypeScript “this” scoping issue when called in jquery callback
  4. What is the difference between types String and string?
  5. How do I prevent the error “Index signature of object type implicitly has an ‘any’ type” when compiling typescript with noImplicitAny flag enabled?
  6. Does Typescript support the ?. operator? (And, what’s it called?)
  7. How can I listen for keypress event on the whole page?
  8. Select based on enum in Angular2
  9. ‘Cannot redeclare block-scoped variable’ in unrelated files
  10. typescript template literal as interface key
  11. How to undestand relations between types any, unknown, {} and between them and other types?
  12. Typescript Function with Generic Return Type
  13. Typescript Key-Value relation preserving Object.entries type
  14. Difference between extending and intersecting interfaces in TypeScript?
  15. How to do runtime type casting in TypeScript?
  16. How can moment.js be imported with typescript?
  17. How can an object type with nested subproperties be flattened?
  18. Accessing properties in union types
  19. How can I remove a wider type from a union type without removing its subtypes in TypeScript?
  20. Checking validity of string literal union type at runtime?
  21. Generating typescript declaration files from javascript
  22. TypeScript sorting an array
  23. “An index signature parameter type cannot be a union type.” – what should I use instead?
  24. Detailed differences between type annotation `variable: type` and type assertion `expression as type` in TypeScript
  25. Generic and typeof T in the parameters
  26. How to make “handler” lookup for “dispatcher” style function be typed correctly
  27. How do I decide whether @types/* goes into `dependencies` or `devDependencies`?
  28. How to define an interface for objects with dynamic keys?
  29. Types from both keys and values of object in Typescript
  30. Modules vs. Namespaces: What is the correct way to organize a large typescript project?

Leave a Comment