文字列の配列として 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 を使用する必要があります。 ts コマンドではなく変換 API。この制限により、使いやすさが妨げられる可能性があります。

代替案

カスタム トランスフォーマが実現できないシナリオでは、代替オプションとして次のようなものがあります。

• リフレクション手法の使用 (パフォーマンスの観点から推奨されません)理由)
• プロパティ名の配列を明示的に指定する (人的エラーとメンテナンスのオーバーヘッドが発生しやすい)