TypeScript Twoslash

TypeScriptコード用のマークアップ形式。TypeScriptコンパイラが追加の作業を行う、自己完結型のコードサンプルを作成するのに最適です。

TypeScriptを知っていれば、基本的にtwoslashもわかります。

Twoslashでは、tsconfigオプションをインラインで宣言したり、サンプルを複数のファイルに分割したり、その他の便利なコマンドを使用することができます。READMEで 完全なAPIを確認できます

Twoslashマークアップ言語は、以下のことに役立ちます。

  • TypeScriptコードサンプルから正確なエラーを強制し、メッセージングをコンパイラに任せる
  • コードサンプルを分割して、気を散らすコードを隠す
  • コードサンプル内のシンボルを宣言的に強調表示する
  • コードを、異なるファイルへのトランスパイル結果、または.d.tsや.mapファイルなどの補助ファイルに置き換える
  • 単一のコードサンプルで複数ファイルのインポートを処理する
  • コードのプレイグラウンドリンクを作成する

マークアップ

TS Twoslashがコード内の識別子の強調表示情報をどのように取得するかをご覧ください

サンドボックスをダウンロード中...

実行時型を強調表示
エラーを表示
コンパイラフラグを設定
コードをトリミング
JSを表示
DTSを表示
強調表示

結果

使用方法

Twoslashの使用方法ガイドは、npmのREADMEで @typescript/twoslash.