luhn-mod-n-algorithm/README.md

Creates and validates Luhn Mod N check values

# luhn-mod-n-algorithm

![GitHub](https://img.shields.io/github/license/alfredmyers/luhn-mod-n-algorithm.svg?style=flat)
![Node CI](https://github.com/alfredmyers/luhn-mod-n-algorithm/workflows/Node%20CI/badge.svg)
![Node.js Package](https://github.com/alfredmyers/luhn-mod-n-algorithm/workflows/Node.js%20Package/badge.svg)

Generates and calculates Luhn Mod N check values

Code based on <https://en.wikipedia.org/wiki/Luhn_mod_N_algorithm>
with minimal modifications.

## Installing

```sh
npm i luhn-mod-n-algorithm
```

## API

### Parameters

Parameter | Description
--- | ---
codePointFromCharacter | Function to obtain a code point from a character
characterFromCodePoint | Function to obtain a character from a code point
n | Base, radix or number of valid characters