# iban-helper

> A javascript library to validate, format and convert IBAN (International Bank Account Number) and BBAN (Basic Bank Account Number)

Latest version **0.0.20230703140417** (published 2023-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install iban-helper
pnpm add iban-helper
yarn add iban-helper
bun add iban-helper
```

## 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.0.20230703140417 |
| Published | 2023-07-03 |
| First published | 2023-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Eric Verydellei |
| Maintainers | testercrayon |

## Links

- npm: https://www.npmjs.com/package/iban-helper
- Repository: https://github.com/everydellei/iban.js
- Homepage: https://github.com/everydellei/iban.js#readme
- Issues: https://github.com/everydellei/iban.js/issues
- npm.io page: https://npm.io/package/iban-helper

## Dependencies (1)

- [iban-helper](https://npm.io/package/iban-helper.md) >0.0.14

## Recent versions

- 0.0.20230703140417 (latest) — 2023-07-03
- 0.0.20230624085638 — 2023-06-24
- 0.0.20230624080530 — 2023-06-24
- 0.0.20230624075016 — 2023-06-24
- 0.0.20230624072516 — 2023-06-24
- 0.0.20230624071257 — 2023-06-24
- 0.0.20230623092335 — 2023-06-23
- 0.0.20230623091741 — 2023-06-23
- 0.0.20230623091540 — 2023-06-23
- 0.0.20230623091307 — 2023-06-23
- 0.0.20230623090958 — 2023-06-23
- 0.0.20230623090414 — 2023-06-23

## README

# iban.js

IBAN and BBAN validation, formatting and conversion in Javascript.

IBAN.js follows the [ISO 13616 IBAN Registry technical specification](https://www.swift.com/standards/data-standards/iban).

## Usage

IBAN.js is compatible with both commonjs and AMD module definition. It can be used as a [node.js module](#in-nodejs) and [in the browser](#in-the-browser). It also has a bower manifest, a [Typescript definition](#with-typescript) and a [Meteor wrapper](#with-meteor-framework).

### In node.js

```js
var IBAN = require('iban');
IBAN.isValid('hello world'); // false
IBAN.isValid('BE68539007547034'); // true
```

### In the browser

Using a module loader (AMD or commonjs) or directly through the global ```IBAN``` object:

```html
<script src="iban.js"></script>
<script>
    // the API is now accessible from the window.IBAN global object
    IBAN.isValid('hello world'); // false
    IBAN.isValid('BE68539007547034'); // true
</script>
```

### With TypeScript

The library is also available from the typescript language. To do this, [download the definition](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/iban) and add a reference to this:

```typescript
/// <reference path="iban.d.ts" />
IBAN.isValid('hello world');
IBAN.isValid('BE68539007547034');
```

### With Meteor framework

A wrapper package for the Meteor framework is available [here](https://atmospherejs.com/theduke/iban).

## API

* isValid(iban)
* toBBAN(iban, separator)
* fromBBAN(countryCode, bban)
* isValidBBAN(countryCode, bban)
* printFormat(iban, separator)
* electronicFormat(iban)

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