Машинопис: Як визначити інтерфейси для вкладених об’єктів?


95

Припустимо, у мене є корисне навантаження JSON, яке аналізується приблизно так:

{
    name: "test",
    items: {
        "a": {
            id: 1,
            size: 10
        },
        "b": {
            id: 2,
            size: 34
        }
    }
}

Як налаштувати визначення прикладу інтерфейсу, щоб змоделювати, що значення властивості items - це об’єкт, ключі якого є рядками, а значення якого визначаються інтерфейсом Item:

export interface Example {
    name: string;
    items: ???;

}

export interface Item {
    id: number;
    size: number;
}

Відповіді:


163

Машинопис дозволяє додавати тип для ключів об’єктів за допомогою синтаксису [key: string].

Як зазначено в документації, їх називають типами, що індексуються :

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

У вашому випадку ви б використали наступне:

export interface Item {
    id: number;
    size: number;
}

export interface Example {
    name: string;
    items: {
        [key: string]: Item
    };
}

Для довідки, ось посилання на приклад у реальному часі .


2
Чому ви експортуєте Itemінтерфейс? Чи не Exampleдостатньо експорту просто інтерфейсу?
— Олександр Кім

2
@AlexanderKim так, якщо Itemце не корисно для іншого коду, що також використовує ці типи.
— evanrmurphy

хтось знає, як встановити клавіші елементів із станом та отримати до них доступ?
— Собака

@Dog, звичайно, але це не веб-сайт "код для мене"
— Emobe

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