Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 1.88 KB

README.md

File metadata and controls

83 lines (56 loc) · 1.88 KB
Raw

ican.js

ICAN and BCAN validation, formatting, and conversion in JavaScript.

ICAN.js adheres to the ISO 13616 IBAN Registry technical specification and includes support for Crypto addresses.

Usage

ICAN.js is compatible with both CommonJS and AMD module definitions.

NPM

You can install @blockchainhub/ican from NPM using Yarn, NPM, or another tool.

Yarn

yarn add @blockchainhub/ican

NPM

npm i @blockchainhub/ican

In node.js

var ICAN = require('@blockchainhub/ican');
ICAN.isValid('hello world'); // false
ICAN.isValid('BE68539007547034'); // true

In the browser

You can use a module loader (AMD or CommonJS) or access it directly through the global ICAN object:

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

With React

Using ICAN.js with React is easy. For example:

import Ican from '@blockchainhub/ican';
Ican.isValid('hello world');
Ican.isValid('BE68539007547034');

API

  • isValid(ican, onlyCrypto)
  • toBCAN(ican, separator, onlyCrypto)
  • fromBCAN(countryCode, bcan)
  • isValidBCAN(countryCode, bcan, onlyCrypto)
  • printFormat(ican, separator)
  • electronicFormat(ican)
  • shortFormat(ican, separator, frontCount, backCount)

Contributions

We welcome contributions in any form. Here's how you can help:

Epigram

「Cryptoni Confidimus」

License

Licensed under the CORE License.