# jpbank-number-converter

> ゆうちょ銀行（Japan Post Bank）のキャッシュカードに記載されている記号・番号から、他行とのやりとりに使用する口座番号・支店名・支店番号に変換するライブラリ

Latest version **0.1.1** (published 2018-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install jpbank-number-converter
pnpm add jpbank-number-converter
yarn add jpbank-number-converter
bun add jpbank-number-converter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-03-18 |
| First published | 2018-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ryo-a |
| Maintainers | ryo-a |

## Links

- npm: https://www.npmjs.com/package/jpbank-number-converter
- Repository: https://github.com/ryo-a/jpbank-number-converter
- npm.io page: https://npm.io/package/jpbank-number-converter

## Recent versions

- 0.1.1 (latest) — 2018-03-18
- 0.1.0 — 2018-03-18

## README

# jpbank-number-converter

[![CircleCI](https://circleci.com/gh/ryo-a/jpbank-number-converter.svg?style=svg)](https://circleci.com/gh/ryo-a/jpbank-number-converter)

ゆうちょ銀行（Japan Post Bank）のキャッシュカードや通帳に記載されている、ゆうちょ独自の番号から他の銀行口座とやりとりする場合に使う口座番号・支店名などに変換するライブラリです。ゆうちょ銀行・日本郵政などとは一切関係ない非公式なものです。

ゆうちょ銀行はその歴史的な経緯から一般的な金融機関と異なる管理番号が使用されていますが、現在は他の金融機関に準じた番号が用意されています。  
しかしながら、利用者の手元にあるキャッシュカードからはそれが分かりづらく、[ゆうちょ銀行のサイト](https://www.jp-bank.japanpost.jp/kojin/sokin/furikomi/kouza/kj_sk_fm_kz_1.html)にて変換をする必要があります。  

このライブラリはゆうちょ銀行のサイトにて示されている[変換の公式](https://www.jp-bank.japanpost.jp/kojin/sokin/koza/kj_sk_kz_furikomi_ksk.html)に基づき、上記公式サイトの変換ページと同等の結果を得るためのシンプルなライブラリです。


## 使用方法

```js
const jpbank = require('jpbank-number-converter');

var result = jpbank.convert({jpbankSignNumber: '11940',jpbankMiddleNumber:'1',jpbankNumber:'12345'});
// jpbankSignNumber: ゆうちょ銀行で「記号」と称される、ハイフンより前の番号
// jpbankMiddleNumber: 01940-1-12345 のように、2つのハイフンに挟まれる番号（少なくとも現時点では計算には使用していません）
// jpbankNumber: ゆうちょ銀行で「番号」と称される、ハイフンより後の番号

console.log(result.isTransferAccount); //true 振替口座であるかどうか。記号の先頭の数字が1であれば振替口座です。
console.log(result.branchNumber); //199
console.log(result.branchName); //一九九
console.log(result.branchNameKatakana); //イチキユウキユウ
console.log(result.accountNumber); //12345
console.log(result.accountNumberFilled); // 0012345（口座番号が7桁未満だった場合、先頭から0で埋めたもの）
```

## 免責事項
MIT Licenseの通り、ライブラリの使用によって発生したトラブルに関して作者は一切の責任を負いません。  
実際に金銭の授受が発生するプラットフォームで導入する場合、入念なテストを行った上で使用してください。

---
_Source: https://npm.io/package/jpbank-number-converter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._