ir-iban



Tools to work with IBAN, BBAN, Their validation

$3

IBAN - شماره شبا

BBAN - شماره حساب

!image of structure of IBAN number

#### How to Download
``js
npm i ir-iban
`

#### How to import
`js
const { isIbanValid, turnBbanIntoIban, BANK_CODES, formatIban } = require('ir-iban')
`

or

`js
import { isIbanValid, turnBbanIntoIban, BANK_CODES, formatIban } from "ir-iban"
`

#### How to use
#

Functions
* turnBbanIntoIban
* turnIbanIntoBban
* isIbanValid
* tokenizeIban
* isBankCodeValid
* getBankNameFromIban
* formatIban

#### isIbanValid
این تابع مشخص میکند که آیا شماره شبا معتبر است و یا خیر

example
`js
const iban = "IR870570028180010653892101"
const isValid = isIbanValid(iban)
// output: true
`

#### turnBbanIntoIban
این تابع شماره حساب را به شماره شبا تبدیل میکند

bban: string

bankCode: string -- use enum BANK_COES for example BANK_CODES.TEJARAT

bbanType = "0" -- optional

0 یعنی حساب سپرده

1 یعنی حساب تسهیلات

countryCode = "IR" -- optional


example
`js
const bban = "4695069893"
// turnBbanIntoIban(bban: string, bankCode: string, bbanType?: string, countryCode?: string)
const iban = turnBbanIntoIban(bban, BANK_CODES.TEJARAT)
`

#### turnIbanIntoBban
شماره شبا را به شماره حساب تبدیل میکند

It return undefined if iban was not valid

example
`js
const iban = "IR870570028180010653892101"
const bban = turnIbanIntoBban(iban) // output: bban or undefined (if iban is not valid)
`

#### tokenizeIban
یک آبجکت از ساختار سازنده شماره شبا در خروجی میدهد و اگر شماره شبا نا معتبر بود آبجکت خالی میدهد

It returns the tokenized iban via object or returns an empty object if iban was not valid

exmaple

`js
const iban = "IR870570028180010653892101"
const tokenizedIban = tokenizeIban(iban)
// {
// countryCode: "IR",
// CD: "87",
// CC: "057",
// bbanType: "0",
// BBAN: "028180010653892101"
// }
`

#### getBankNameFromIban
با توجه به شماره شبا نام فارسی بانک را بر می گرداند

example
`js
const iban = "IR870180028180010653892101"
const farsiBankName = getBankNameFromIban(iban)
// output: "بانک تجارت"
`

#### isBankCodeValid
این تابع مشخص میکند که آیا کد بانک معتبر است و یا خیر

you can get bank codes from enum BANK_CODES

example

`js
const isValid = isBankCodeValid("018") // 018 is BANK_CODES.TEJARAT
// output: true
`

#### formatIban
شماره شبا را به فرم استاندارد در خروجی می دهد

`js
const iban = "IR870570028180010653892101"
const formattedIban = formatIban(iban)
// output: IR87 0570 0281 8001 0653 8921 01
``

#

MIT License

Copyright (c)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.