Jクラブ経営情報コアパッケージ

概要

コアパッケージには以下の3つのパッケージが搭載されています。

• データパッケージ: @cieloazul310/jclub-financial-data
• 統計パッケージ（開発中）: @cieloazul310/jclub-financial-statistics
• ユーティリティパッケージ: @cieloazul310/jclub-financial-utils

使い方

インストール

npm install @cieloazul310/jclub-financial

データを使用する

JavaScript/TypeScriptから

[!WARNING] @cieloazul310/jclub-financial-data は内部で fs/promises や path などの Node.js 標準モジュールを使用しています。
そのため、このパッケージは ブラウザ環境では使用できません。
Node.js 環境（ビルド時・サーバーサイド）での利用を前提としています。

import { 
  getDataByClub,
  getDataByYear,
  getDatum,
} from "@cieloazul310/jclub-financial/data";

Functions

getDataByClub(clubId) ⇒ Promise.<Array.<FinancialDatum>>

Kind: global function
Returns: Promise.<Array.<FinancialDatum>> - 指定されたクラブIDのデータの配列
See: FinancialDatum

| Param | Type | Description | | --- | --- | --- | | clubId | string | クラブID |

getDataByYear(year) ⇒ Promise.<Array.<FinancialDatum>>

Kind: global function
Returns: Promise.<Array.<FinancialDatum>> - 指定された年度のデータの配列

| Param | Type | Description | | --- | --- | --- | | year | number | 年度 |

getDatum(clubId, year) ⇒ Promise.<(FinancialDatum|null)>

Kind: global function
Returns: Promise.<(FinancialDatum|null)> - 指定された年度範囲のデータ
See: FinancialDatum

| Param | Type | Description | | --- | --- | --- | | clubId | string | クラブID | | year | number | 年度 |

ユーティリティを利用する

import {
  getAllClubs,
  getClubById,
  getClubsByCategory,
  getAllYears,
  getYearInfo,
  getLabel,
  getLabelWithOptions,
} from "@cieloazul310/jclub-financial";

Functions

getAllClubs() ⇒ Array.<ClubInfo>

Kind: global function
Returns: Array.<ClubInfo> - すべてのクラブの情報の配列を返します
See

• ClubInfo
• clubs.yml

~~getClubBySlug()~~

use getClubById

Kind: global function

getClubById(clubId) ⇒ ClubInfo | undefined

Kind: global function
Returns: ClubInfo | undefined - 指定したクラブの情報を返します。存在しない場合はundefinedを返します。
See

• ClubInfo
• clubs.yml

| Param | Type | Description | | --- | --- | --- | | clubId | string | クラブID |

getClubsByCategory(category) ⇒ Array.<ClubInfo>

Kind: global function
Returns: Array.<ClubInfo> - 指定したカテゴリのクラブの情報の配列を返します
See

• ClubInfo
• clubs.yml

| Param | Type | Description | | --- | --- | --- | | category | string | カテゴリ(J1, J2, J3, JFL) |

getLabel(key) ⇒ string

Kind: global function
Returns: string - 日本語ラベル。未定義のキーの場合はキー名をそのまま返す
See

• FinancialDatum
• dictionary.yml

| Param | Type | Description | | --- | --- | --- | | key | string | FinancialDatum のプロパティ名 |

getLabelWithOptions(key, [options]) ⇒ string

Kind: global function
Returns: string - 日本語ラベル
See

• FinancialDatum
• dictionary.yml

| Param | Type | Description | | --- | --- | --- | | key | string | FinancialDatum のプロパティ名 | | [options] | Object | fallback や後処理のオプション | | [options.fallback] | string | キーが未定義の場合のフォールバック。省略時はキー名を返す |

getAllYears() ⇒ Array.<YearInfo>

Kind: global function
Returns: Array.<YearInfo> - 年度情報の配列
See

• YearInfo
• years.yml

getYearInfo(year) ⇒ YearInfo | undefined

Kind: global function
Returns: YearInfo | undefined - 年度情報。該当する年度が存在しない場合は undefined
See

• YearInfo
• years.yml

| Param | Type | Description | | --- | --- | --- | | year | number | 年度 |

JSONデータを利用する

データはパッケージのdistディレクトリに以下のように格納されています。
クライアント側で動的にデータを取得する場合は、データをpublicディレクトリなどにコピーして利用してください。

node_modules/@cieloazul310/jclub-financial-data/dist
├── albirex
│   ├── 2005.json
│   ├── 2006.json
│   ├── 2007.json
│   ├── ...
│   ├── 2024.json
│   ├── index.cjs
│   ├── index.d.ts
│   └── index.mjs
├── antlers
├── ardija
├── ...
├── zweigen
├── index.cjs
├── index.d.ts
└── index.mjs

| 略称 | 呼称 | clubId | | ------ | --------- | -------- | | 鹿島 | 鹿島アントラーズ | antlers | | 水戸 | 水戸ホーリーホック | mitohollyhock | | 浦和 | 浦和レッズ | urawa | | 千葉 | ジェフユナイテッド千葉 | jefunited | | 柏 | 柏レイソル | reysol | | FC東京 | FC東京 | fctokyo | | 東京V | 東京ヴェルディ | verdy | | 町田 | FC町田ゼルビア | zelvia | | 川崎 | 川崎フロンターレ | kawasaki | | 横浜FM | 横浜F・マリノス | fmarinos | | 清水 | 清水エスパルス | shimizu | | 名古屋 | 名古屋グランパス | nagoya | | 京都 | 京都サンガF.C. | sanga | | G大阪 | ガンバ大阪 | gamba | | C大阪 | セレッソ大阪 | cerezo | | 神戸 | ヴィッセル神戸 | vissel | | 岡山 | ファジアーノ岡山 | fagiano | | 広島 | サンフレッチェ広島 | sanfrecce | | 福岡 | アビスパ福岡 | avispa | | 長崎 | V・ファーレン長崎 | vvaren | | 札幌 | 北海道コンサドーレ札幌 | consadole | | 八戸 | ヴァンラーレ八戸 | vanraure | | 仙台 | ベガルタ仙台 | vegalta | | 秋田 | ブラウブリッツ秋田 | blaublitz | | 山形 | モンテディオ山形 | montedio | | いわき | いわきFC | iwakifc | | 栃木C | 栃木シティ | tochigicity | | 大宮 | RB大宮アルディージャ | ardija | | 横浜FC | 横浜FC | yokohamafc | | 湘南 | 湘南ベルマーレ | bellmare | | 甲府 | ヴァンフォーレ甲府 | ventforet | | 新潟 | アルビレックス新潟 | albirex | | 富山 | カターレ富山 | kataller | | 磐田 | ジュビロ磐田 | jubilo | | 藤枝 | 藤枝MYFC | myfc | | 徳島 | 徳島ヴォルティス | vortis | | 今治 | FC今治 | fcimabari | | 鳥栖 | サガン鳥栖 | sagan | | 大分 | 大分トリニータ | trinita | | 宮崎 | テゲバジャーロ宮崎 | tegevajaro | | 福島 | 福島ユナイテッドFC | fufc | | 栃木SC | 栃木SC | tochigisc | | 群馬 | ザスパ群馬 | thespa | | 相模原 | SC相模原 | scsagamihara | | 松本 | 松本山雅FC | yamaga | | 長野 | AC長野パルセイロ | parceiro | | 金沢 | ツエーゲン金沢 | zweigen | | 岐阜 | FC岐阜 | fcgifu | | 滋賀 | レイラック滋賀FC | reilac | | FC大阪 | FC大阪 | fcosaka | | 奈良 | 奈良クラブ | naraclub | | 鳥取 | ガイナーレ鳥取 | gainare | | 山口 | レノファ山口FC | renofa | | 讃岐 | カマタマーレ讃岐 | kamatamare | | 愛媛 | 愛媛FC | ehimefc | | 高知 | 高知ユナイテッドSC | kochi | | 北九州 | ギラヴァンツ北九州 | giravanz | | 熊本 | ロアッソ熊本 | roasso | | 鹿児島 | 鹿児島ユナイテッドFC | kufc | | 琉球 | FC琉球 | fcryukyu | | 岩手 | いわてグルージャ盛岡 | gurulla | | YS横浜 | Y.S.C.C.横浜 | yscc | | 沼津 | アスルクラロ沼津 | azulclaro |

License

MIT © cieloazul310