Skip to content

getAbbreviationStats ​

INFO

houki-abbreviations v0.7.1 の dist/index.d.ts と specs/current/get_abbreviation_stats/spec.md から自動生成しました(仕様 ID 6 件・2026-10-10)。手で編集しないでください。再生成は node scripts/generate-reference.mjs です。

関数 ・ v0.1.0 で追加 ・ family では未使用

辞書全体の統計を返す。

利用者と得られる結果 ​

この関数の利用者と、利用者が渡すもの・得られる結果を示します。

  • houki-hub family の MCP サーバーと、このパッケージを import する利用者のコード。起動時のログや診断で、取り込んだ辞書の件数を確かめるために呼ぶ

シグネチャ ​

import して呼ぶときの形です。パッケージの型定義(dist/index.d.ts)から写しています。

ts
function getAbbreviationStats(): AbbreviationStats;

戻り値: 全件数、ドメイン別件数、カテゴリ別件数、管轄 MCP 別件数(定数の全値がキーで、無い値は 0)

関係する型: AbbreviationStats

扱わないこと ​

この関数が意図して扱わないことです。

  • 分野などで絞り込んだ件数を返すこと(引数は無い。絞り込んだ一覧は listByDomain / listByCategory / listBySourceMcpHint)
  • 辞書の版や更新日を返すこと
  • 別名の件数や、名前(略称・正式名称・別名)の総数を返すこと
  • 辞書の整合性を検査すること(validateAllEntries)

処理の流れ ​

仕様書の「処理の流れ」の節を、図も含めてそのまま写しています。図が大きいので畳んでいます。

処理の流れの図(仕様書の写し)

図の中の番号は「できること」の仕様 ID の末尾 3 桁です。

仕様項目の一覧 ​

この関数の仕様項目 6 件の見出しです。仕様項目は受入テストと 1 対 1 で対応していて、条件と例は仕様書ページで読めます。

仕様項目の見出し(6 件)
仕様 ID仕様項目
001total は辞書のエントリの件数
002分野別・種別別・MCP 別の件数の合計は total と等しい
003byDomain には 6 分野すべてが 1 件以上で入る
004呼ぶたびに新しいオブジェクトを返す
005byDomain・byCategory・bySourceMcpHint は定数の全値をキーに、定数の順で持つ
006辞書にエントリの無い値は 0 を返す

関連ページ ​

このページの元になった文書と、あわせて読むページです。

本サイトの内容は調査の出発点であり、法的助言ではありません。個別の事案は資格を持つ専門家に相談してください。免責事項と利用範囲