Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 1.4 KB

README.md

File metadata and controls

58 lines (34 loc) · 1.4 KB

dni-js

Compute and validate a Spanish DNI/NIE numbers as described here.

Build Status npm version

Install

$ npm install dni-js

Usage

Validation is based on this document.

const dni = require('dni-js');

dni.isValid('12345678-Z'); // => true

API

.dni (number|string)

Returns a DNI number with the control digit appended in the format 12345678-Z. If the input is invalid, returns null.

.nie (number|string)

Returns a NIE number with the control digit appended in the format X1234567-L. If the input is invalid, returns null.

.getControlDigit (number|string)

Returns the control digit for the input.

.getLetter (number|string)

Alias for getControlDigit.

.isValid (string)

Returns true or false by validating the input.

.normalize (string)

Given a string input, it returns a normalized valid DNI. When input is either not a string, or invalid, it returns null. For example:

dni.normalize('   12 34 56 7 8-z'); // 12345678-Z

License

MIT