Доступ к ключам интерфейса Typescript как массиву строк

Введение

Работа с табличными данными в Typescript требует использования интерфейсов для определения столбца структуры. Чтобы эффективно манипулировать этими структурами, часто необходимо получить имена свойств этих интерфейсов в виде массива строк.

Решение

Использование пользовательских преобразователей

Начиная с версии Typescript 2.4 пользовательские преобразователи предоставляют механизм извлечения ключей из интерфейсов. Рассмотрим следующий интерфейс:

interface IMyTable {
  id: number;
  title: string;
  createdAt: Date;
  isDeleted: boolean;
}

Чтобы получить имена свойств в виде массива:

import { keys } from 'ts-transformer-keys';

const IMyTable = keys();

console.log(IMyTable); // ["id", "title", "createdAt", "isDeleted"]

Ограничения пользовательских преобразователей

Хотя пользовательские преобразователи предлагают удобное решение, они требуют использования Typescript API трансформации, а не команду ts. Это ограничение может затруднить их использование.

Альтернативы

В сценариях, где пользовательские преобразователи невозможны, альтернативные варианты включают:

• Использование методов отражения (не рекомендуется для повышения производительности). причины)
• Явное указание массива имен свойств (возможны человеческие ошибки и накладные расходы на обслуживание)