12k
All articles

習得する価値のある、あまり知られていないTypeScriptの機能

const型パラメーターやNoInferからアサーション関数、verbatimModuleSyntaxまで、あまり知られていないTypeScript機能7つをバージョンとコード例付きで解説します。

OpenReplay Team
OpenReplay Team
習得する価値のある、あまり知られていないTypeScriptの機能

経験豊富な開発者でもまだ使っていないことが多いTypeScriptの機能として、次の7つが挙げられます。const型パラメーター(5.0)、NoInfer(5.4)、アサーション関数(3.7)、ラベル付きタプル要素(4.0)、変性アノテーション(4.7)、accessorキーワード(4.9)、そしてimport typeとverbatimModuleSyntaxの組み合わせ(3.8および5.0)です。

TypeScriptを4.x系の頃に学び、その後は開発に追われてきたのであれば、今でも呼び出し側でas constを書いたり、推論による型の拡大(widening)を防ぐために余分な型パラメーターを追加したりしているのではないでしょうか。新しいリリースでは、どちらもより簡潔に書けるようになっています。

本記事では、各機能について「何をするのか」「どのバージョンで導入されたのか」を解説し、strictモードでコンパイルできる短いサンプルを1つずつ紹介します。

重要なポイント

  • const型パラメーター(TypeScript 5.0)を使うと、制約がreadonly string[]のようなreadonlyの場合、["/", "/users"]はreadonly ["/", "/users"]として推論されます。
  • NoInfer<T>(TypeScript 5.4)は、パラメーターが推論の候補(inference site)として扱われるのを防ぎます。そのため、デフォルト値によって、他の引数から確定した型が拡大されることはありません。
  • asserts value is Tとして記述したアサーション関数は、ifブロック内だけでなく、呼び出し以降のスコープ全体で引数の型を絞り込みます。
  • verbatimModuleSyntaxのもとでは、typeが文全体に適用されている場合にのみimportが削除されます。import { type X } from "./mod"はimport {} from "./mod"として出力されるため、モジュールは引き続き実行されます。

バージョン別・TypeScriptの高度な機能

次の表は、あまり知られていない7つのTypeScriptの機能について、導入されたバージョンと、特に恩恵を受ける開発者をまとめたものです。

機能導入バージョン主な対象
アサーション関数3.7アプリケーションおよびライブラリのコード
import type3.8ビルド設定
ラベル付きタプル要素4.0フックやAPIの作成者
変性アノテーション(in/out)4.7ライブラリ作成者
accessorキーワード4.9デコレーターの利用者
const型パラメーター5.0ジェネリックAPIの作成者
verbatimModuleSyntax5.0ビルド設定
NoInfer<T>5.4ジェネリックAPIの作成者

const型パラメーター(TypeScript 5.0)

TypeScript 5.0では、型パラメーターにconst修飾子が追加されました。これにより、コンパイラーは配列リテラルやオブジェクトリテラルを、呼び出し側がas constを書いたかのように推論します。呼び出し側は、リテラル型を得るためにアサーションを忘れずに書く必要がなくなります。

readonlyな結果が必要な場合は、const修飾子とreadonlyな制約を組み合わせてください。string[]のようなミュータブルな制約の場合、TypeScript 5.0〜5.2ではstring[]にフォールバックしていました。5.3以降では、代わりにミュータブルなタプルとして推論されます。また、const修飾子が適用されるのは、呼び出し時に直接記述されたリテラルのみです。事前に宣言された変数は、すでに拡大された型をそのまま保持します。

function defineRoutes<T extends readonly string[]>(paths: T): T { return paths; }
const a = defineRoutes(["/", "/users"]);        // string[]

function defineRoutesExact<const T extends readonly string[]>(paths: T): T { return paths; }
const b = defineRoutesExact(["/", "/users"]);   // readonly ["/", "/users"]

function defineRoutesMutable<const T extends string[]>(paths: T): T { return paths; }
const c = defineRoutesMutable(["/", "/users"]); // ["/", "/users"] (TS 5.3+; string[] in 5.0–5.2)

NoInferによる推論の制御(TypeScript 5.4)

TypeScript 5.4で追加されたNoInfer<T>は、特定の引数をコンパイラーが推論の情報源として使うことを防ぎます。その引数は型を拡大する代わりに、他のパラメーターから推論された型に対してチェックされます。5.4より前は、1つ目の型パラメーターで制約した2つ目の型パラメーターを使うのが一般的な回避策でした。これでも機能はしましたが、シグネチャ内で一度しか登場しない型パラメーターが増えてしまうという欠点がありました。

function createSelect<T extends string>(options: T[], initial: NoInfer<T>) {
  return { options, value: initial };
}

createSelect(["draft", "published"], "draft");    // OK
createSelect(["draft", "published"], "archived");
// Error: Argument of type '"archived"' is not assignable
// to parameter of type '"draft" | "published"'.

NoInferがなければ、Tは"draft" | "published" | "archived"に拡大され、タイプミスがあってもコンパイルが通ってしまいます。ユーティリティ型のリファレンスでは、PartialやPickと並んでこの型が解説されています。

アサーション関数(TypeScript 3.7)

アサーション関数は、例外をスローせずに処理を返した時点で、それを囲むスコープの残り全体で引数の型を絞り込みます。そのため、分岐を必要としないフェイルファストなガード節に最適です。型ガード(value is T)は、それを呼び出す条件分岐の内部でしか型を絞り込みません。一方、TypeScript 3.7で導入されたasserts value is Tシグネチャは、呼び出し以降のすべてのコードで型を絞り込みます。

function assertIsDefined<T>(value: T, name = "value"): asserts value is NonNullable<T> {
  if (value === undefined || value === null) {
    throw new Error(`${name} is not defined`);
  }
}

const root = document.getElementById("app"); // HTMLElement | null
assertIsDefined(root, "#app");
root.classList.add("ready");                 // root: HTMLElement

アサーション関数には1つ注意点があります。ヘルパーを、型注釈のないconstに代入したアロー関数として記述すると、呼び出し箇所で「Assertions require every name in the call target to be declared with an explicit type annotation.」というエラーが発生します。関数宣言を使うか、constに明示的な型を付けてください。

ラベル付きタプル要素(TypeScript 4.0)

TypeScript 4.0で追加されたラベル付きタプル要素を使うと、タプル型の各位置に名前を付けられます。この名前は、エディターのホバー表示、シグネチャヘルプ、エラーメッセージに表示されます。タプルのラベルが変えるのは、エディターやエラーメッセージでの表示だけです。タプルの型自体は変わらず、呼び出し側は任意の名前で要素を分割代入できます。TypeScript 5.2以降では、ラベル付き要素とラベルなし要素を1つのタプル内で混在させることもできます。

典型的なユースケースは、フック形式の戻り値の型です。

type ToggleState = [isOn: boolean, toggle: () => void];

function useToggle(initial = false): ToggleState {
  let isOn = initial;
  return [isOn, () => { isOn = !isOn; }];
}

const [open, toggleOpen] = useToggle(); // any names work; labels show in hovers

変性アノテーション:inとout(TypeScript 4.7)

TypeScript 4.7で導入された変性アノテーションを使うと、型パラメーターが共変(out)、反変(in)、またはその両方であることを明示的に宣言できます。変性アノテーションは主にライブラリ作成者向けの機能で、アプリケーションのコードで必要になることはほとんどありません。4.7のリリースノートでは、意図をドキュメント化する手段として、また深く再帰する型において型チェックを高速化する手段として紹介されています。TypeScriptは、アノテーションがパラメーターの実際の使われ方と矛盾する場合にエラーを報告しますが、必要以上に厳しいアノテーションは許容します。

interface Producer<out T> { get: () => T }
interface Consumer<in T> { accept: (value: T) => void }

interface Bad<in T> { get: () => T }
// Error: Type 'Bad<super-T>' is not assignable to type 'Bad<sub-T>'
// as implied by variance annotation.

accessorキーワード(TypeScript 4.9)

TypeScript 4.9では自動アクセサー(auto-accessor)が追加されました。クラスフィールドと同じように宣言し、先頭にaccessorを付けます。コンパイラーはこれを、外部からアクセスできないプライベートフィールドを裏側に持つgetterとsetterのペアに変換します。これにより自動アクセサーは、フィールドの読み取りと書き込みの両方をデコレーターが1か所でインターセプトできるようにします。

以下の例では、TypeScript 5.0の標準デコレーターのシグネチャを使用しており、型はコンパイラーに組み込まれたdecorators.d.tsのものです。レガシーデコレーターは異なるシグネチャを使うため、experimentalDecoratorsは無効にしておく必要があります。

function logged<This, V>(
  target: ClassAccessorDecoratorTarget<This, V>,
  context: ClassAccessorDecoratorContext<This, V>
): ClassAccessorDecoratorResult<This, V> {
  return {
    set(value) {
      console.log(`set ${String(context.name)} =`, value);
      target.set.call(this, value);
    },
  };
}

class Settings {
  @logged accessor theme = "light";
}

import typeとverbatimModuleSyntax(TypeScript 3.8および5.0)

verbatimModuleSyntaxのもとでは、TypeScriptはtypeが文全体に適用されている場合にのみimportを削除します。それ以外のimportはすべて記述どおりに出力されます。import type構文はTypeScript 3.8から存在しています。フラグ自体は5.0で導入され、importsNotUsedAsValuesとpreserveValueImportsを置き換えました。これら2つは5.0で非推奨となり、TypeScript 7では廃止されています。

{ "compilerOptions": { "verbatimModuleSyntax": true } }
import type { User } from "./api";         // erased entirely
import { fetchUser, type Post } from "./api"; // emits: import { fetchUser } from "./api";
import { type Config } from "./config";    // emits: import {} from "./config";

つまずきやすいのは3行目のimport { type Config }です。インラインのtype修飾子を使っても空のimportが残るため、モジュールは読み込まれ、その副作用も実行されます。このフラグを有効にすると、type修飾子なしでインポートされた型はすべてコンパイルエラーになります。移行作業の大部分は、型のみの名前付きimportをimport typeに書き換えることです。

関連するTypeScriptの高度なトピック

以下のトピックは、それぞれ個別の記事があるため、本記事では意図的に取り上げていません。

まとめ

これらの機能の多くは、回避策を置き換えるか、実行時の慣習に頼っていたチェックを型システムに移すものです。const型パラメーターとNoInferは、呼び出し側に余計な手間をかけさせることなく、ジェネリックAPIに正確な推論をもたらします。アサーション関数とラベル付きタプルは日常的なアプリケーションコードをより堅牢にし、verbatimModuleSyntaxは出力されるimportを予測可能にします。実践的な第一歩としては、まず1つのパッケージでverbatimModuleSyntaxを有効にし、コンパイラーが指摘した型のみのimportを修正しましょう。次に、現在呼び出し側にas constの付加を求めているジェネリックにconstを追加するとよいでしょう。

よくある質問

verbatimModuleSyntaxはCommonJSを出力するプロジェクトでも使えますか?

はい、使えます。ただし、CommonJSとして出力されるファイルでは、TypeScriptのCommonJSスタイルの構文を使う必要があります。インポートにはimport fs = require('fs')、エクスポートにはexport =を使用します。これらのファイルでESMのimport文やexport文を書くとコンパイルエラーになります。現在のリリースではTS1295として報告され、package.jsonのtypeフィールドを変更するか、moduleの設定を調整するよう提案されます。ESMとして出力されるファイルでは、通常のimport構文とexport構文をそのまま使えます。

verbatimModuleSyntaxを有効にした場合、isolatedModulesは引き続き必要ですか?

いいえ、必要ありません。TSConfigリファレンスによると、verbatimModuleSyntaxが有効な場合、isolatedModulesはデフォルトでtrueに設定されます。そのため、単一ファイルのトランスパイルに関するチェックは自動的に適用され、明示的な設定は削除して構いません。これらのチェックは、esbuild、SWC、Babelのように各ファイルを個別にコンパイルし、インポートされた名前が型なのか値なのかを判別できないツールにとって重要です。

アサーション関数を非同期にすることはできますか?

いいえ、できません。TypeScriptには非同期のアサーションシグネチャが存在しないため、Promise<asserts value is T>のような戻り値の型は無効です。この機能はTypeScriptのissue 37681で要望されていますが、言語仕様には含まれていません。一般的な回避策は、先に非同期処理をawaitしてから、その結果に対して同期的なアサーション関数を呼び出すか、非同期関数が絞り込まれた型で検証済みの値を返すようにすることです。

Open-source session replay

Complete picture for complete understanding

Capture every clue your frontend is leaving so you can instantly get to the root cause of any issue with OpenReplay — the open-source session replay tool for developers. Self-host it in minutes, and have complete control over your customer data.

Star on GitHub12k

We use cookies to improve your experience. By using our site, you accept cookies.