lookupByLawId
INFO
houki-abbreviations v0.7.1 の dist/index.d.ts と specs/current/lookup_by_law_id/spec.md から自動生成しました(仕様 ID 7 件・2026-10-10)。手で編集しないでください。再生成は node scripts/generate-reference.mjs です。
関数 ・ v0.5.0 で追加 ・ family では未使用
e-Gov law_id から辞書エントリを引く。完全一致のみ。
options.normalize が true のとき、全角英数字を半角にしてから比べる(v0.7.0 から)。 小文字は大文字にしない。既定は false で、v0.6.1 までと同じ結果を返す。
利用者と得られる結果
この関数の利用者と、利用者が渡すもの・得られる結果を示します。
- houki-abbreviations を import する利用者(houki-egov-mcp・houki-nta-mcp などの MCP サーバー、またはアプリケーション)。e-Gov の法令 ID(
law_id)を渡して、その法令の略称・正式名称などを持つ辞書のエントリを受け取る
シグネチャ
import して呼ぶときの形です。パッケージの型定義(dist/index.d.ts)から写しています。
ts
function lookupByLawId(law_id: string, options?: LookupByLawIdOptions): AbbreviationEntry | null;| 引数 | 説明 |
|---|---|
law_id | e-Gov の law_id |
options | 照合オプション(省略可) |
関係する型: AbbreviationEntry・LookupByLawIdOptions
例
型定義の JSDoc に書かれている例です。
例
ts
import { lookupByLawId } from '@shuji-bonji/houki-abbreviations';
lookupByLawId('363AC0000000108')?.formal; // '消費税法'
lookupByLawId('321CONSTITUTION')?.formal; // '日本国憲法'
lookupByLawId('999XX0000000000'); // null
lookupByLawId('363AC0000000108', { normalize: true })?.formal; // '消費税法'(v0.7.0 から)
lookupByLawId('363AC0000000108'); // null扱わないこと
この関数が意図して扱わないことです。
- 大文字・小文字の違いを吸収すること(
363ac0000000108はnormalize: trueでもnull) - 通達など
law_idがnullのエントリ(v0.6.0 の辞書で 174 件中 165 件)を引くこと - 法令番号から引くこと(
lookupByLawNum) - 略称・正式名称・別名から引くこと(
resolveAbbreviation) law_idの形式が e-Gov の規則に合うかを確かめること(isValidLawId)- 1 回の呼び出しで複数の
law_idを引くこと
処理の流れ
仕様書の「処理の流れ」の節を、図も含めてそのまま写しています。図が大きいので畳んでいます。
処理の流れの図(仕様書の写し)
図の中の番号は「できること」の仕様 ID の末尾 3 桁です。
仕様項目の一覧
この関数の仕様項目 7 件の見出しです。仕様項目は受入テストと 1 対 1 で対応していて、条件と例は仕様書ページで読めます。
仕様項目の見出し(7 件)
| 仕様 ID | 仕様項目 |
|---|---|
| 001 | law_id が完全一致するエントリを返す |
| 002 | 前後の空白を無視する |
| 003 | 一致するエントリが無ければ null を返す |
| 004 | 空文字・空白だけの law_id には null を返す |
| 005 | normalize: true では全角英数字を半角にしてから引く |
| 006 | normalize: true でも英字の小文字は大文字にしない |
| 007 | normalize を省くか false にすると全角と半角を別の文字として引く |
関連ページ
このページの元になった文書と、あわせて読むページです。