node-iso11649

node-iso11649

ISO 11649:2009 RF creditor reference library for node

• No dependencies
• 4 KB (1.2 KB gzipped)

Installation

with NPM

npm install node-iso11649 --save

with Yarn

yarn add node-iso11649

Usage

Generating RF creditor reference

RF creditor reference can be generated from existing reference.

Existing reference characteristics:

• Contain only numbers 0-9 and/or characters A-Z (example AB2G5 => RF68AB2G5).
• Max length 21 characters.
• Not case sensitive (example aB2g5 => RF68AB2G5).
• Can be string with spaces (example '12345 12345' => RF451234512345).

import { generate } from 'node-iso11649'

console.log(generate('12345 12345'))
// => RF451234512345

RF creditor reference can be generated also without existing reference. In that case epoch timestamp increased with random number and finnish checksum at the end is used.

NOTE: While this provides some level of randomness, uniqueness is not guaranteed. In production, it is best to use cryptographically secure random numbers at least as a part of the reference.

Example result:

import { generate } from 'node-iso11649'

console.log(generate())
// => RF4714508655422864

As creditor references are commonly displayed in groups of 4 characters you can use the optional pretty flag to format the returned value.

import { generate } from 'node-iso11649'

console.log(generate('12345 12345', {pretty: true}))
// => RF45 1234 5123 45

Validating RF creditor reference

Valid RF creditor reference characteristics:

• Must start with characters RF.
• Must contain two checksum numbers in indexes 3 and 4.
• Reference part must follow rules described in 'Existing reference characteristics' section.

import { validate } from 'node-iso11649'

console.log(validate('RF4714508655422864'))
// => true

import { validate } from 'node-iso11649'

console.log(validate('RF00TEST'))
// => false

Parsing RF creditor reference

The reference part can be extracted from the RF creditor reference. This validates the entered RF creditor reference according to the 'Validating RF creditor reference'. It returns the reference string if valid and null if invalid.

import { parse } from 'node-iso11649'

console.log(parse('RF47 1450 8655 4228 64'))
// => 14508655422864

import { parse } from 'node-iso11649'

console.log(parse('RF00TEST'))
// => null

Tests

Run ESLint style checker.

npm run lint

Run unit tests

npm test

Changelog

3.0.0 (2023-18-11)

BREAKING: Change generate function signature to have separate parameters for reference and options

• Improve randomness and uniqueness of RF references generated without existing reference
• Update dependencies
• Replace deprecated substr with slice
• Rollup type declaration file
• Improve documentation