TypeScript: Turn an Array of Values into a Type Union

I found the answer I was looking for here: https://dev.to/shakyshane/2-ways-to-create-a-union-from-an-array-in-typescript-1kd6

I wasn't sure that it would be possible. In fact, it turns out that the solution is far more impressive than I expected.

What follows cuts to the core part of the article that I need solved my particular problem.

Problem

I want to have an object type with specific keys and I want a static array of those keys, but I don't want to have the same list of keys written out twice in case I mistakenly make them differ in the future 

type K = "a" | "b" | "c";
type O = Record<K, V>;
const keys: K[] = ["a","b","c"];

I want to be sure that 'keys' contains every member of type 'K' exactly once and vice-versa. I want to use 'keys' to build an object of type 'O', so I can't just rely on using 'Object.keys' on an existing object.

Solution

const keys = ["a","b","c"] as const;
type K = typeof keys[number];
type O = Record<K, V>;

Use 'as const' to make the type of  'keys' be interpreted as a readonly tuple of strings, whereas before it was an array, 'K[]', which could have any members of 'K' anywhere zero or more times each.

Because 'keys' is a value, it needs to be prefixed with 'typeof' to use its type in a type expression.

By indexing a tuple type with a specific number, you can get the type at that position in the tuple.

The incredible part: By indexing the tuple type with a union of numbers, you get the union of the types at those positions. Therefore by indexing 'typeof keys', which is a tuple, with 'number', which is the union of all numbers, you get the union of all strings in 'keys'. 

type T = ["a", "b", "c"][0]; // "a"
type T = ["a", "b", "c"][0 | 1]; // "a" | "b"
type T = ["a", "b", "c"][number]; // "a" | "b" | "c"

Comments

Post a Comment

Popular posts from this blog

Fix Controller Input when a Game Doesn't Use Steam Input

Background Knowledge Steam Input is an interface for developers to use the controller configuration built into Steam for their games. It is entirely optional and not all games use it. Steam gives you the option to enable and disable Steam Input on a per game basis. Steam has controller button mapping for in-game, Big Picture Mode, and on desktop (outside of games), and mappings for individual games. By default Steam will give certain controllers a desktop mapping that lets you move the mouse and bring up an on-screen keyboard, which is not what you want in a game. If you press F11 in a game and Steam Overlay doesn't appear and you have it configured to appear, Steam thinks that you are not in a game, and therefore it will use the desktop mapping instead of the in-game mapping. Steam Input works by capturing inputs from your controller, suppressing them from the rest of your system and emitting the inputs that you desire instead to the rest of your system. Problem If you are playin
Read more

Fix Inability to Move Files to Trash in VSC

You need to configure an environment variable to tell Electron (what VSC is built on) how to trash things. In ~/.profile add: export ELECTRON_TRASH=trash-put You'll need to install trash-put separately. "gio trash" might be a pre-installed alternative. I thought that's what I was using but apparently not.
Read more

VSC Vanishing Go Imports

With the Go extension installed in VSC, by default if you have an unused import, when you save, it will disappear. If you're like me and you may habitually press ctrl+s, this is very frustrating. After a lot of messing around in VSC's settings. I learned that this "feature" has nothing to do with the settings pertaining to linting or formatting. It's actually to do with automatic import organisation, which you can configure as follows in VSC's settings.json. "[go]" : { "editor.codeActionsOnSave" : { "source.organizeImports" : false, }, } This solution comes from this StackOverflow answer. You can still organise imports with the shortcut shift+alt+o.
Read more