Typescript виводить тип об’єднання із значень кортежу / масиву


95

Скажімо, у мене є список const list = ['a', 'b', 'c']

Чи можна вивести з цього типу об'єднання значень, який є 'a' | 'b' | 'c'?

Я хочу цього, тому що хочу визначити тип, який допускає лише значення зі статичного масиву, а також повинен перераховувати ці значення під час виконання, тому я використовую масив.

Приклад того, як це можна реалізувати за допомогою індексованого об’єкта:

const indexed = {a: null, b: null, c: null}
const list = Object.keys(index)
type NeededUnionType = keyof typeof indexed

Цікаво, чи можливо це зробити без використання індексованої карти.


Отже, по суті, ви хотіли б генерувати типи на льоту?
— SwiftsNamesake

Типи існують лише під час компіляції, тому ви не можете створювати їх динамічно під час виконання.
— jonrsharpe

Це цікаве питання. Який ваш варіант використання?
— профспілка

Відповіді:


200

ОНОВИТИ Лют 2019

У TypeScript 3.4, який повинен вийти в березні 2019 року, можна буде сказати компілятору зробити висновок про тип кортежу літералів як кортеж літералів , а не як, скажімо string[], за допомогою as constсинтаксису . Цей тип твердження змушує компілятор зробити висновок про найвужчий можливий тип значення, включаючи все readonly. Це повинно виглядати так:

const list = ['a', 'b', 'c'] as const; // TS3.4 syntax
type NeededUnionType = typeof list[number]; // 'a'|'b'|'c';

Це усуне необхідність у допоміжній функції будь-якого типу. Успіху ще раз усім!


ОНОВЛЕННЯ Липень 2018

Схоже, починаючи з TypeScript 3.0, TypeScript зможе автоматично виводити типи кортежів . Після випуску потрібну tuple()вам функцію можна коротко написати:

export type Lit = string | number | boolean | undefined | null | void | {};
export const tuple = <T extends Lit[]>(...args: T) => args;

І тоді ви можете використовувати його так:

const list = tuple('a','b','c');  // type is ['a','b','c']
type NeededUnionType = typeof list[number]; // 'a'|'b'|'c'

Сподіваюся, це працює для людей!


ОНОВИТИ Грудень 2017

Оскільки я опублікував цю відповідь, я знайшов спосіб зробити висновок про типи кортежів, якщо ви бажаєте додати функцію до своєї бібліотеки. Перевірте функцію tuple()в tuple.ts . Використовуючи його, ви можете написати наступне і не повторюватись:

const list = tuple('a','b','c');  // type is ['a','b','c']
type NeededUnionType = typeof list[number]; // 'a'|'b'|'c'

Удачі!


ОРИГІНАЛ липня 2017 року

Однією з проблем є те, що літерал ['a','b','c']буде виводитися як тип string[], тому система типів забуде про конкретні значення. Ви можете змусити систему типів запам’ятовувати кожне значення як літеральний рядок:

const list = ['a' as 'a','b' as 'b','c' as 'c']; // infers as ('a'|'b'|'c')[]

Або, можливо, краще, інтерпретувати список як тип кортежу:

const list: ['a','b','c'] = ['a','b','c']; // tuple

Це дратує повторення, але принаймні воно не вводить сторонній об'єкт під час виконання.

Тепер ви можете отримати свій союз таким чином:

type NeededUnionType = typeof list[number];  // 'a'|'b'|'c'.

Сподіваюся, що це допомагає.


Це відмінне рішення для проблеми, з якою я стикаюся досить часто, коли мені потрібні перевірки виконання (за допомогою кортежу) та компіляція перевірок часу за допомогою об'єднання типів. Хтось знає, чи докладаються зусилля, щоб додати підтримку для неявного введення кортежу до мови?
— Йорген Тведт

Спробував ваше рішення, але воно НЕ працює зcont xs = ['a','b','c']; const list = tuple(...xs);
— Мігелем Карвахалем

1
Це не повинно працювати з цим, так як на той час ви const xs = ['a','b','c']компілятор вже розширив xsдо string[]і зовсім забув про конкретні значеннях. Я не можу допомогти цій поведінці, принаймні, як у TS3.2 (хоча може бути майбутнє as constпозначення, яке працює). У будь-якому випадку, я думаю, що відповідь на сьогоднішній день все ще настільки правильна, наскільки я можу це зробити (я згадую там, що ['a','b','c']виводиться як string[]), тому я не впевнений, що вам ще потрібно.
— jcalz

3
хтось може пояснити, що [number]робить у list[number]?
— Орелус,

3
Це аналізується як (typeof list)[number]... ні typeof (list[number]). Тип T[K]- це тип пошуку, який отримує тип властивості T, ключем якого є K. В (typeof list)[number], ви отримуєте типи властивостей , (typeof list)чиї ключі number. Масиви типу typeof listмають числові підписи індексу , тому їх numberключ дає об’єднання всіх числових індексованих властивостей.
— jcalz

15

Оновлення для TypeScript 3.4:

Новий синтаксис під назвою "const context", який надійде в TypeScript 3.4, дозволить отримати ще простіше рішення, яке не вимагає виклику функції, як показано. Зараз ця функція переглядається, як видно з цього PR .

Коротше кажучи, цей синтаксис дозволяє створювати незмінні масиви, які мають вузький тип (тобто тип ['a', 'b', 'c']замість ('a' | 'b' | 'c')[]або string[]). Таким чином, ми можемо створити типи об’єднання з літералів так просто, як показано нижче:

const MY_VALUES = <const> ['a', 'b', 'c']
type MyType = typeof MY_VALUES[number]

В альтернативному синтаксисі:

const MY_VALUES = ['a', 'b', 'c'] as const
type MyType = typeof MY_VALUES[number]

Привіт, щойно знайшов свою відповідь після публікації цього запитання. Я дам вам заробити трохи карми, якщо ви хочете відповісти;) stackoverflow.com/questions/56113411/…
— Себастьян Лорбер

2

Це неможливо зробити за допомогою Array.

Причина в тому, що навіть якщо ви оголосите змінну як const, вміст масиву все одно може змінюватися, тому @jonrsharpe згадує, що це час виконання.

Враховуючи те, що ви хочете, може бути краще використовувати interfaceз keyof:

interface X {
    a: string,
    b: string
}

type Y = keyof X  // Y: 'a' | 'b'

Або enum:

enum X { a, b, c }

Чи є спосіб виключити певні поля? Наприклад, якщо я хочу лише aполе ..
— neomib,

Ви можете використовувати Pick<T, U>для цього.
— профспілка
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.