typescript restrict count of object’s properties

by

There are many answers to this question on Stackoverflow (including this detailed one), but none of them worked for my situation, which is similar to the one posted here.

Problem

I have a function that takes an object. I want it to throw a Compilation Error (Typescript) if the passed object doesn’t have exactly one key. e.g.

f({}); // Must error here, as it has less than one key!
f({ x: 5 });
f({ x: 5, y : 6 }); // Must error here, as it has more than one key!

Solution

Using the popular UnionToIntersection and IsUnion, I achieved it via the following utility function.

type SingleKey<T> = IsUnion<keyof T> extends true ? never : {} extends T ? never : T;

Full Code:

// From https://stackoverflow.com/a/50375286
type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;

// From: https://stackoverflow.com/a/53955431
type IsUnion<T> = [T] extends [UnionToIntersection<T>] ? false : true;

// Here we come!
type SingleKey<T> = IsUnion<keyof T> extends true ? never : {} extends T ? never : T;

// Usage:
function f<T extends Record<string, any>>(obj: SingleKey<T>) {
    console.log({ obj });
}

f({}); // errors here!
f({ x: 5 });
f({ x: 5, y : 6 }); // errors here!

Playground Link

More Related Contents:

  1. Interfaces vs Types in TypeScript
  2. Why does A | B allow a combination of both, and how can I prevent it?
  3. How to return value from function which has Observable subscription inside?
  4. Why can’t I return a generic ‘T’ to satisfy a Partial?
  5. Typescript: TS7006: Parameter ‘xxx’ implicitly has an ‘any’ type
  6. Parameters generic of overloaded function doesn’t contain all options
  7. Enforcing the type of the indexed members of a Typescript object?
  8. Constructor overload in TypeScript
  9. Typescript: Can I define an n-length tuple type?
  10. TypeScript 2: custom typings for untyped npm module
  11. Exclude/overwrite npm-provided typings
  12. How to use namespaces with import in TypeScript
  13. Difference between type[] and [type] in typescript
  14. How can I create an object based on an interface file definition in TypeScript?
  15. How can I define an array of objects?
  16. How to require a specific string in TypeScript interface
  17. Typescript has unions, so are enums redundant?
  18. Rules for the use of angle brackets in TypeScript
  19. How to use select/option/NgFor on an array of objects in Angular2 [duplicate]
  20. ‘Property does not exist on type ‘never’
  21. TypeScript sorting an array
  22. “An index signature parameter type cannot be a union type.” – what should I use instead?
  23. Detailed differences between type annotation `variable: type` and type assertion `expression as type` in TypeScript
  24. Generic and typeof T in the parameters
  25. Typescript: type narrowing not working for `in` when key is stored in a variable
  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