Promise.<Array.<FinancialDatum>>指定されたクラブIDのデータを取得する
Promise.<Array.<FinancialDatum>>年度を指定してデータを取得する
Promise.<(FinancialDatum|null)>年度とクラブを指定してデータを取得する
Promise.<Array.<FinancialDatum>>\n指定されたクラブIDのデータを取得する
\n\n**Kind**: global function \n**Returns**:Promise.<Array.<FinancialDatum>> - 指定されたクラブIDのデータの配列
\n**See**: [FinancialDatum](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/src/types/data.ts) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| clubId |string | クラブID
|\n\n\n\n#### getDataByYear(year) ⇒Promise.<Array.<FinancialDatum>>\n年度を指定してデータを取得する
\n\n**Kind**: global function \n**Returns**:Promise.<Array.<FinancialDatum>> - 指定された年度のデータの配列
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| year |number | 年度
|\n\n\n\n#### getDatum(clubId, year) ⇒Promise.<(FinancialDatum\\|null)>\n年度とクラブを指定してデータを取得する
\n\n**Kind**: global function \n**Returns**:Promise.<(FinancialDatum\\|null)> - 指定された年度範囲のデータ
\n**See**: [FinancialDatum](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/src/types/data.ts) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| clubId |string | クラブID
|\n| year |number | 年度
|\n\n\n\n\n### ユーティリティを利用する\n\n```ts\nimport {\n getAllClubs,\n getClubById,\n getClubsByCategory,\n getAllYears,\n getYearInfo,\n getLabel,\n getLabelWithOptions,\n} from \"@cieloazul310/jclub-financial\";\n```\n\n\n#### Functions\n\nArray.<ClubInfo>利用可能なすべてのJクラブ情報を取得する関数。ソートはカテゴリ順(J1, J2, J3, その他)。
ClubInfo | undefined指定したclubIdのJクラブ情報を取得する関数
Array.<ClubInfo>指定したカテゴリのすべてのJクラブ情報を取得する
stringプロパティ名から日本語ラベルを取得する
stringプロパティ名から日本語ラベルを取得する（オプションつき）
Array.<YearInfo>利用可能なすべての年度情報を取得する。ソートは年度昇順
YearInfo | undefined指定された年度の情報を取得する
Array.<ClubInfo>\n利用可能なすべてのJクラブ情報を取得する関数。ソートはカテゴリ順(J1, J2, J3, その他)。
\n\n**Kind**: global function \n**Returns**:Array.<ClubInfo> - すべてのクラブの情報の配列を返します
\n**See**\n\n- [ClubInfo](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/club.ts)\n- [clubs.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/clubs.yml)\n\n\n\n#### ~~getClubBySlug()~~\n***use `getClubById`***\n\n**Kind**: global function \n\n\n#### getClubById(clubId) ⇒ClubInfo \\| undefined\n指定したclubIdのJクラブ情報を取得する関数
ClubInfo \\| undefined - 指定したクラブの情報を返します。存在しない場合はundefinedを返します。
string | クラブID
|\n\n\n\n#### getClubsByCategory(category) ⇒Array.<ClubInfo>\n指定したカテゴリのすべてのJクラブ情報を取得する
\n\n**Kind**: global function \n**Returns**:Array.<ClubInfo> - 指定したカテゴリのクラブの情報の配列を返します
\n**See**\n\n- [ClubInfo](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/club.ts)\n- [clubs.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/clubs.yml)\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| category |string | カテゴリ(J1, J2, J3, JFL)
|\n\n\n\n#### getLabel(key) ⇒string\nプロパティ名から日本語ラベルを取得する
\n\n**Kind**: global function \n**Returns**:string - 日本語ラベル。未定義のキーの場合はキー名をそのまま返す
\n**See**\n\n- [FinancialDatum](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/data.ts)\n- [dictionary.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/dictionary.yml)\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key |string | FinancialDatum のプロパティ名
string\nプロパティ名から日本語ラベルを取得する（オプションつき）
\n\n**Kind**: global function \n**Returns**:string - 日本語ラベル
\n**See**\n\n- [FinancialDatum](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/data.ts)\n- [dictionary.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/dictionary.yml)\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key |string | FinancialDatum のプロパティ名
Object | fallback や後処理のオプション
|\n| [options.fallback] |string | キーが未定義の場合のフォールバック。省略時はキー名を返す
|\n\n\n\n#### getAllYears() ⇒Array.<YearInfo>\n利用可能なすべての年度情報を取得する。ソートは年度昇順
\n\n**Kind**: global function \n**Returns**:Array.<YearInfo> - 年度情報の配列
\n**See**\n\n- [YearInfo](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/year.ts)\n- [years.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/years.yml)\n\n\n\n#### getYearInfo(year) ⇒YearInfo \\| undefined\n指定された年度の情報を取得する
\n\n**Kind**: global function \n**Returns**:YearInfo \\| undefined - 年度情報。該当する年度が存在しない場合は undefined
\n**See**\n\n- [YearInfo](https://github.com/cieloazul310/jclub-financial-table/blob/develop/packages/utils/src/types/year.ts)\n- [years.yml](https://github.com/cieloazul310/jclub-financial-table/blob/main/packages/utils/years.yml)\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| year |number | 年度
|\n\n\n\n\n### JSONデータを利用する\n\nデータはパッケージの`dist`ディレクトリに以下のように格納されています。 \nクライアント側で動的にデータを取得する場合は、データを`public`ディレクトリなどにコピーして利用してください。\n\n```txt\nnode_modules/@cieloazul310/jclub-financial-data/dist\n├── albirex\n│ ├── 2005.json\n│ ├── 2006.json\n│ ├── 2007.json\n│ ├── ...\n│ ├── 2024.json\n│ ├── index.cjs\n│ ├── index.d.ts\n│ └── index.mjs\n├── antlers\n├── ardija\n├── ...\n├── zweigen\n├── index.cjs\n├── index.d.ts\n└── index.mjs\n```\n\n\n| 略称 | 呼称 | clubId |\n| ------ | --------- | -------- |\n| 鹿島 | 鹿島アントラーズ | antlers |\n| 水戸 | 水戸ホーリーホック | mitohollyhock |\n| 浦和 | 浦和レッズ | urawa |\n| 千葉 | ジェフユナイテッド千葉 | jefunited |\n| 柏 | 柏レイソル | reysol |\n| FC東京 | FC東京 | fctokyo |\n| 東京V | 東京ヴェルディ | verdy |\n| 町田 | FC町田ゼルビア | zelvia |\n| 川崎 | 川崎フロンターレ | kawasaki |\n| 横浜FM | 横浜F・マリノス | fmarinos |\n| 清水 | 清水エスパルス | shimizu |\n| 名古屋 | 名古屋グランパス | nagoya |\n| 京都 | 京都サンガF.C. | sanga |\n| G大阪 | ガンバ大阪 | gamba |\n| C大阪 | セレッソ大阪 | cerezo |\n| 神戸 | ヴィッセル神戸 | vissel |\n| 岡山 | ファジアーノ岡山 | fagiano |\n| 広島 | サンフレッチェ広島 | sanfrecce |\n| 福岡 | アビスパ福岡 | avispa |\n| 長崎 | V・ファーレン長崎 | vvaren |\n| 札幌 | 北海道コンサドーレ札幌 | consadole |\n| 八戸 | ヴァンラーレ八戸 | vanraure |\n| 仙台 | ベガルタ仙台 | vegalta |\n| 秋田 | ブラウブリッツ秋田 | blaublitz |\n| 山形 | モンテディオ山形 | montedio |\n| いわき | いわきFC | iwakifc |\n| 栃木C | 栃木シティ | tochigicity |\n| 大宮 | RB大宮アルディージャ | ardija |\n| 横浜FC | 横浜FC | yokohamafc |\n| 湘南 | 湘南ベルマーレ | bellmare |\n| 甲府 | ヴァンフォーレ甲府 | ventforet |\n| 新潟 | アルビレックス新潟 | albirex |\n| 富山 | カターレ富山 | kataller |\n| 磐田 | ジュビロ磐田 | jubilo |\n| 藤枝 | 藤枝MYFC | myfc |\n| 徳島 | 徳島ヴォルティス | vortis |\n| 今治 | FC今治 | fcimabari |\n| 鳥栖 | サガン鳥栖 | sagan |\n| 大分 | 大分トリニータ | trinita |\n| 宮崎 | テゲバジャーロ宮崎 | tegevajaro |\n| 福島 | 福島ユナイテッドFC | fufc |\n| 栃木SC | 栃木SC | tochigisc |\n| 群馬 | ザスパ群馬 | thespa |\n| 相模原 | SC相模原 | scsagamihara |\n| 松本 | 松本山雅FC | yamaga |\n| 長野 | AC長野パルセイロ | parceiro |\n| 金沢 | ツエーゲン金沢 | zweigen |\n| 岐阜 | FC岐阜 | fcgifu |\n| 滋賀 | レイラック滋賀FC | reilac |\n| FC大阪 | FC大阪 | fcosaka |\n| 奈良 | 奈良クラブ | naraclub |\n| 鳥取 | ガイナーレ鳥取 | gainare |\n| 山口 | レノファ山口FC | renofa |\n| 讃岐 | カマタマーレ讃岐 | kamatamare |\n| 愛媛 | 愛媛FC | ehimefc |\n| 高知 | 高知ユナイテッドSC | kochi |\n| 北九州 | ギラヴァンツ北九州 | giravanz |\n| 熊本 | ロアッソ熊本 | roasso |\n| 鹿児島 | 鹿児島ユナイテッドFC | kufc |\n| 琉球 | FC琉球 | fcryukyu |\n| 岩手 | いわてグルージャ盛岡 | gurulla |\n| YS横浜 | Y.S.C.C.横浜 | yscc |\n| 沼津 | アスルクラロ沼津 | azulclaro |\n\n## License\n\nMIT © [cieloazul310](https://github.com/cieloazul310)","readmeFilename":"README.md"}