Посилення типу індексованих членів об’єкта Typescript?

Я хотів би зберегти відображення рядка -> рядка в об'єкті Typescript і застосувати, щоб усі клавіші відображалися в рядках. Наприклад:

var stuff = {};
stuff["a"] = "foo";   // okay
stuff["b"] = "bar";   // okay
stuff["c"] = false;   // ERROR!  bool != string

Чи є спосіб я встановити, що значення повинні бути рядками (або будь-яким іншим типом ..)?

var stuff: { [key: string]: string; } = {};
stuff['a'] = ''; // ok
stuff['a'] = 4;  // error

// ... or, if you're using this a lot and don't want to type so much ...
interface StringMap { [key: string]: string; }
var stuff2: StringMap = { };
// same as above

interface AgeMap {
    [name: string]: number
}

const friendsAges: AgeMap = {
    "Sandy": 34,
    "Joe": 28,
    "Sarah": 30,
    "Michelle": "fifty", // ERROR! Type 'string' is not assignable to type 'number'.
};

Тут інтерфейс AgeMapзастосовує клавіші як рядки, а значення - як числа. Ключове слово nameможе бути будь-яким ідентифікатором і його слід використовувати, щоб запропонувати синтаксис вашого інтерфейсу / типу.

Ви можете використовувати аналогічний синтаксис, щоб переконатися, що об’єкт має ключ для кожного запису типу об'єднання:

type DayOfTheWeek = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";

type ChoresMap = { [day in DayOfTheWeek]: string };

const chores: ChoresMap = { // ERROR! Property 'saturday' is missing in type '...'
    "sunday": "do the dishes",
    "monday": "walk the dog",
    "tuesday": "water the plants",
    "wednesday": "take out the trash",
    "thursday": "clean your room",
    "friday": "mow the lawn",
};

Ви, звичайно, також можете зробити це загальним типом!

type DayOfTheWeek = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";

type DayOfTheWeekMap<T> = { [day in DayOfTheWeek]: T };

const chores: DayOfTheWeekMap<string> = {
    "sunday": "do the dishes",
    "monday": "walk the dog",
    "tuesday": "water the plants",
    "wednesday": "take out the trash",
    "thursday": "clean your room",
    "friday": "mow the lawn",
    "saturday": "relax",
};

const workDays: DayOfTheWeekMap<boolean> = {
    "sunday": false,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
};

Оновлення 10.10.2018: Перевірте відповідь @ dracstaxi нижче - тепер є вбудований тип, Recordякий робить для вас більшу частину цього.

1.2.2020 оновлення: я повністю видалив попередньо зроблені інтерфейси відображення зі своєї відповіді. @ dracstaxi відповідь робить їх абсолютно нерелевантними. Якщо ви все ще хочете їх використовувати, перевірте історію редагування.

Швидке оновлення: оскільки Typescript 2.1 існує вбудований тип, Record<T, K>який діє як словник.

Приклад із документів:

// For every properties K of type T, transform it to U
function mapObject<K extends string, T, U>(obj: Record<K, T>, f: (x: T) => U): Record<K, U>

const names = { foo: "hello", bar: "world", baz: "bye" };
const lengths = mapObject(names, s => s.length);  // { foo: number, bar: number, baz: number }

Документація TypeScript 2.1 увімкнена Record<T, K>

Єдиний недолік я бачу в використанні над цим в {[key: T]: K}тому , що ви можете кодувати корисну інформацію про якому ключі використовується замість «ключа» , наприклад , якщо об'єкт був тільки прості ключі можна натякнути , що ось так: {[prime: number]: yourType}.

Ось я написав регулярний вираз, щоб допомогти у перетворенні. Це конвертуватиме лише випадки, коли мітка "ключ". Для перетворення інших міток просто змініть першу групу захоплення:

Знайти: \{\s*\[(key)\s*(+\s*:\s*(\w+)\s*\]\s*:\s*([^\}]+?)\s*;?\s*\}

Замінити: Record<$2, $3>

@Ryan Cavanaugh відповідь повністю гаразд і досі справедлива. І все-таки варто додати, що станом на Fall'16, коли ми можемо стверджувати, що ES6 підтримується більшістю платформ, майже завжди краще дотримуватися карти, коли вам потрібно пов’язати деякі дані з якимсь ключем.

Коли ми пишемо, let a: { [s: string]: string; }нам потрібно пам’ятати, що після компіляції машинопису не існує такого поняття, як дані типу, він використовується лише для компіляції. І {[s: string]: string; } складеться до {}.

Це сказало, навіть якщо ви напишете щось на кшталт:

class TrickyKey  {}

let dict: {[key:TrickyKey]: string} = {}

Це просто не буде компілюватися (навіть для target es6, ви отримаєтеerror TS1023: An index signature parameter type must be 'string' or 'number'.

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

Тож цілком безпечно припустити, що найкращою практикою є використання Map, навіть якщо ключі є строковими, тому я б дотримувався:

let staff: Map<string, string> = new Map();

Визначте інтерфейс

interface Settings {
  lang: 'en' | 'da';
  welcome: boolean;
}

Клавіша примусового використання - це конкретний ключ інтерфейсу налаштувань

private setSettings(key: keyof Settings, value: any) {
   // Update settings key
}

Спираючись на відповідь @ shabunc, це дозволить застосувати або ключ, або значення - або те й інше - будь-що, що ви хочете застосувати.

type IdentifierKeys = 'my.valid.key.1' | 'my.valid.key.2';
type IdentifierValues = 'my.valid.value.1' | 'my.valid.value.2';

let stuff = new Map<IdentifierKeys, IdentifierValues>();

Також слід працювати, використовуючи enumзамість typeвизначення.