“An index signature parameter type cannot be a union type.” – what should I use instead?

by

A mapped object type operates on a set of singleton types and produces a new object type where each of those singletons is turned into a property name.

For example, this:

type Foo = {
    [K in "hello" | "world"]: string
};

would be equivalent to

type Foo = {
    "hello": string;
    "world": string;
};

Keep in mind that a mapped object type is a distinct type operator – that syntax in the braces can’t be used in interfaces, or object types with other members. For example

interface Foo {
    [K in "hello" | "world"]: string; // ❌
}

produces the following error:

A computed property name in an interface must refer to an expression whose type is a literal type or a 'unique symbol' type.

Mapped object types are useful for a lot of different things. Read more here: https://www.typescriptlang.org/docs/handbook/2/mapped-types.html

More Related Contents:

  1. What is “not assignable to parameter of type never” error in TypeScript?
  2. Expected 3 type arguments but got 1 but it should infer 2 types
  3. Import class in definition file (*d.ts)
  4. TypeScript union of string and string literals
  5. Are strongly-typed functions as parameters possible in TypeScript?
  6. What does the `is` keyword do in typescript?
  7. Why can I avoid excess property check in typescript just by passing a reference to an object to a function rather than the object in its literal form?
  8. TypeScript: Accept all Object keys that map to a specific type
  9. Typescript interface default values
  10. How to configure custom global interfaces (.d.ts files) for TypeScript?
  11. TypeScript – use correct version of setTimeout (node vs window)
  12. Experimental decorators warning in TypeScript compilation
  13. Using latest JavaScript features in TypeScript, such as ES2018
  14. How to define an opaque type in TypeScript?
  15. What is the Record type?
  16. Mapping tuple-typed value to different tuple-typed value without casts
  17. TypeScript function return type based on input parameter
  18. What does “homomorphic mapped type” mean?
  19. What does “all legal JavaScript is legal TypeScript” mean?
  20. Declare a type that allows all parts of all levels of another type
  21. Empty interface allow any object?
  22. extend and only specify known properties?
  23. Private “functions” in TypeScript
  24. RxJs get value from observable
  25. Implicitly create a tuple in Typescript
  26. How to extend the ‘Window’ typescript interface
  27. Detailed differences between type annotation `variable: type` and type assertion `expression as type` in TypeScript
  28. Generic and typeof T in the parameters
  29. How to make “handler” lookup for “dispatcher” style function be typed correctly
  30. Modules vs. Namespaces: What is the correct way to organize a large typescript project?

Leave a Comment