# @dellacagna/iban 中文文档

规范地址：https://npmcn.com/package/%40dellacagna/iban/

版本：1\.1\.1
npm 元数据更新时间：2023-01-24T18:26:09.549Z
中文译文更新时间：2026-11-11T21:59:39.782Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dellacagna/iban
原文对照：https://npmcn.com/package/%40dellacagna/iban/?lang=original
项目主页：https://github.com/dellacagna/iban#readme
源码仓库：https://github.com/dellacagna/iban

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：40.8 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-01-16T16:56:26.962Z
- 最新版本发布：2023-01-24T18:26:09.424Z
- 近 30 天下载量：4349（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

验证、格式化和生成 IBAN 数字

## 安装

```sh
npm install @dellacagna/iban
```

也可以使用：`pnpm add @dellacagna/iban`、`yarn add @dellacagna/iban`、`bun add @dellacagna/iban`

## README

[![npm version](https://badge.fury.io/js/@dellacagna%2Fiban.svg)](https://badge.fury.io/js/@dellacagna%2Fiban) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dellacagna/iban/master/LICENSE)

# IBAN 图书馆

一个简单的库,用于验证,格式化和生成假 IBAN 数字.

这个图书馆遵循 [ISO 13616 IBAN 登记册技术规格](https://www.swift.com/standards/data-standards/iban-international-bank-account-number) 并支持107个国家.

## 使用量

### 节点JS

```ts
import { IBAN } from '../index';  
let iban = new IBAN('GB82 WEST 1234 5698 7654 32');
if (iban.isValid()) {
    console.log('The IBAN is valid');
}
```

## API 密码

### 时为Valid ()

回返 **真实** 用于有效IBAN或 **虚假** 如果无效.

示例:

```ts
let iban = new IBAN('GB82 WEST 1234 5698 7654 32');
if (iban.isValid()) {
    console.log('The IBAN is valid');
}
```

### 获取错误 ()

如果 IBAN 无效, 则返回以下错误中的一个为字符串 :

```
INVALID_COUNTRY
INVALID_LENGTH
INVALID_FORMAT
CHECKSUM_FAILED
```

示例:

```ts

let iban = new IBAN('GB82 WEST 1234');
if (!iban.isValid()) {
    console.log(!iban.getError()); //prints INVALID_LENGTH
}
```

### 获得原件( )

返回用于即时处理对象的原始未格式化的 IBAN .

示例:

```ts
let iban = new IBAN('GB82 weST 123456987654   32');
let unformatted = iban.getOriginal()
console.log(unformatted); //prints GB82 weST 123456987654   32
```

### 输入电子格式 ()

返回已删除所有空格的 IBAN 资本化 .

示例:

```ts
let iban = new IBAN('GB82 weST 123456987654   32');
let formatted = iban.toElectronicFormat()
console.log(formatted); //prints GB82WEST12345698765432
```

### 打印格式 ()

返回资本化的IBAN,并按国家格式设置空格.

示例:

```ts
let iban = new IBAN('GB82 weST 123456987654   32');
let formatted = iban.toPrintFormat()
console.log(formatted); //prints GB82 WEST 1234 5698 7654 32
```

### 获取BBAN( )

返回已删除所有空格的 BBAN( 基本银行账户号码) .

示例:

```ts
let iban = new IBAN('GB82 WeST 1234 5698 7654 32');
let bban = iban.getBBAN()
console.log(bban); //prints WEST12345698765432
```

### 获取字段( )

返回从有效的 IBAN 中提取信息的对象。 空密钥将不会返回 :

```
{
  countryCode: string;
  country: string;
  checkDigits: string;
  accountNumber?: string;
  currencyCode?: string;
  ownerAccountNumber?: string;
  accountNumberPrefix?: string;
  bicBankCode?: string;
  branchCode?: string;
  accountType?: string;
  nationalCheckDigit?: string;
 }
```

示例:

```ts
let iban = new IBAN('BA39 1290 0794 0102 8494');
let fields = iban.getFields()
console.log(fields);

/* This will output:
  {
    countryCode: 'BA',
    country: 'Bosnia and Herzegovina',
    checkDigits: '39',
    accountNumber: '94010284',
    bankCode: '129',
    branchCode: '007',
    nationalCheckDigit: '94',
 } 
*/
```

### 随机( )

生成一个随机的 IBAN 数字,并以打印格式作为字符串返回. 您可以选择通过国家代码为该国指定一个随机的 IBAN

实例(随机状态国家):

```ts
let iban = IBAN.random();
console.log(iban); //example output: GB82 WEST 1234 5698 7654 32
```

例如(特定国家):

```ts
let iban = IBAN.random('IT');
console.log(iban); //example output: IT60 X054 2811 1010 0000 0123 456
```

## 资源

-   [更改日志](https://github.com/dellacagna/iban/blob/master/CHANGELOG.md)
-   [许可证](https://raw.githubusercontent.com/dellacagna/iban/master/LICENSE)

## 常见问题

### @dellacagna/iban 是什么？

验证、格式化和生成 IBAN 数字

### 如何安装 @dellacagna/iban？

在项目目录运行 npm install @dellacagna/iban，或使用 pnpm add / yarn add / bun add。

### @dellacagna/iban 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dellacagna/iban 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dellacagna/iban 可以商用吗？

@dellacagna/iban 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dellacagna/iban 的下载量有多少？

根据 npm 官方下载统计，@dellacagna/iban 在 2026/10/12 – 2026/11/10 这 30 天内被下载 4,349 次，日均约 145 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dellacagna/iban 还在维护吗？

最新版本 1\.1\.1 发布于 2023/01/25（3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/01/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。