AZ Tools

JSON to JSDoc @typedef ジェネレーター

開発

JSON オブジェクトや配列を貼り付けると、すぐに使える JSDoc @typedef 定義が得られます。各フィールドは JSDoc の型(string、number、boolean、type[])にマッピングされ、ネストされたオブジェクトは個別の @typedef ブロックになります。TypeScript なしでプレーンな JavaScript に型を付けるのに最適です。null と空配列は * (any) 型になります。すべてブラウザ内でローカルに実行され、JSON はアップロードされません。

JSDoc typedef

使い方

  1. 入力ボックスに JSON を貼り付けるか入力します。
  2. 必要に応じてルート typedef 名を変更します(デフォルトは Root)。
  3. 生成された @typedef ブロックを JavaScript ソースにコピーします。

よくある質問

型はどうマッピングされますか?
文字列は string、すべての数値は number、真偽値は boolean になり、配列は最初の要素を基に type[] になります。ネストされたオブジェクトはそれぞれ独自の @typedef を持ち、名前で参照されます。
null や空配列はどうなりますか?
サンプルから型を推論できないため、null は * (any)、空配列は *[] にマッピングされます。実際の型が分かる場合は手動で絞り込んでください。
なぜ TypeScript ではなく JSDoc?
JSDoc @typedef は、ビルド手順や .ts ファイルを追加せずに(例: VS Code や tsc --checkJs で)プレーンな JavaScript を文書化し型チェックできます。
私の JSON はどこかに送信されますか?
いいえ。変換は完全にブラウザ内で行われ、何もアップロードされません。

関連ツール