リファレンス

概要

このセクションは、API 一覧、構成キー、互換性テーブル、サポート対象の CSS 動作、パッケージ横断の網羅範囲台帳など、各リファレンス資料への入口です。

リファレンス	答える内容
CSS サポートマトリクス	HTML パイプラインにおける、CSS 機能ごとの検証済み、申告済み、部分対応、非対応の状態。
連携 API 索引	各フレームワーク、レンダラー、トランスポート、ビルドツール領域を担当する拡張 API ページ。
連携セクション	パッケージ固有の API および構成リファレンスの参照先。
コアモジュールリファレンス	コアリポジトリから生成される、モジュールレベルの API およびアーキテクチャページ。

すべての API エントリでは、同じ問いに答える必要があります。

問い	必須の回答
何を呼び出すか。	完全修飾シンボル、エンドポイント、CLI コマンド、または構成キー。
どの入力を受け付けるか。	型、必須かどうか、デフォルト、許可される値を含むパラメータテーブル。
デフォルトでは何が起こるか。	省略可能な入力を省略した場合の動作。
何が返るか。	戻り値の型、レスポンスボディ、ファイル出力、ストリーム、または副作用。
どのような失敗が起こり得るか。	例外、検証エラー、HTTP ステータス、または運用上の障害モード。
安全に使用するにはどうするか。	セキュリティ、ワーカー安全性、サイズ上限、パス、タイムアウト、シークレットの取り扱いに関する注意事項。

リファレンスページはソースに裏付けられています。公開 API は、パッケージのソース、構成ファイル、テスト、サンプルに基づいてドキュメント化されます。内部ヘルパークラスは、アプリケーション開発者がパッケージを構成または運用するうえでその動作を理解する必要がある場合にのみドキュメント化されます。

リファレンスページでは、情報量の多い段落よりもテーブルを優先します。後続の XLIFF セグメンテーションでは内容がブロック単位で分割されるため、各行だけで意味が通じる必要があります。