ibantools

What is ibantools?

The ibantools npm package provides utilities for validating and formatting International Bank Account Numbers (IBANs). It helps ensure that IBANs are correctly structured and can be used for financial transactions.

What are ibantools's main functionalities?

Validate IBAN

This feature allows you to validate an IBAN to ensure it is correctly formatted and valid. The `validateIBAN` function returns an object indicating whether the IBAN is valid and, if not, what the issues are.

const ibantools = require('ibantools');
const result = ibantools.validateIBAN('DE89370400440532013000');
console.log(result);

Format IBAN

This feature allows you to format an IBAN into a more readable form. The `formatIBAN` function takes an IBAN string and returns it in a standardized format with spaces.

const ibantools = require('ibantools');
const formattedIBAN = ibantools.formatIBAN('DE89370400440532013000');
console.log(formattedIBAN);

Get IBAN Country Information

This feature provides information about the country associated with a given IBAN. The `getIBANCountryInfo` function takes a country code and returns details such as the country name and IBAN length.

const ibantools = require('ibantools');
const countryInfo = ibantools.getIBANCountryInfo('DE');
console.log(countryInfo);

Other packages similar to ibantools

iban

The 'iban' package provides similar functionalities for validating and formatting IBANs. It also includes utilities for generating IBANs and extracting country-specific information. Compared to ibantools, it offers a more comprehensive set of features for handling IBANs.

README

IBANTools

IBANTools is JavaScript library for validation, creation and extraction of IBAN's.

For more information about IBAN see wikipedia page.

Installation and usage

Node (Common JS ES5 and ES6)

$ npm install ibantools

Bower (AMD ES6)

$ bower install ibantools

Usage

Node.js - CommonJS

var ibantools = require('ibantools');
ibantools.isValidIBAN('NL91 ABNA 0517 1643 00');

AMD - RequireJS - Browser

require(["ibantools"], function(ibantools) {
  console.log(ibantools.isValidIBAN('NL91 ABNA 0517 1643 00'));
});

Node.js - Common JS in browser

Use browserify or webpack.

ES6

Use node, not bower module.

If you are using ES6-aware tools, like a rollup or JSPM, they will automatically select ES6 module from the package.

With TypeScript

Typings (new way)

Include ibantools as dependency and run typings install.

TSD (old way)

Link definition file from the package:

$ tsd link

That will add link to ibantools.d.ts in your typings/tsd.d.ts file.

Use it in your .ts files:

/// <reference path="../typings/tsd.d.ts" />
import iban = require("ibantools");
console.log(iban.isValidIBAN("NL91 ABNA 0517 1643 00"));

API

See documentation with examples on Github pages.

Contributing

• npm install and after node node_modules/.bin/typings install (or run typings install if you have typings installed globally).
• Write tests for your changes in test/IBANToolsTest.ts.
• Do not write more tests in karma/ibantoolsSpec.js unless module have problem with loading using AMD.
• Before making pull requests run gulp all-with-tests.
• Try not to make pull requests with changes in dist, es6 or build directories.

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.