The fastest Spanish DNI (NIE / NIF) validation out there.
Installation
// npmnpm i better-dni// yarnyarn add better-dni
Usage
isValid / isNIF / isNIE / ctrlChar
import { isValid, isNIF, isNIE, ctrlChar } from "better-dni";// validates any type of DNI (NIE or NIF)isValid("Z7662566Y"); //=> true// checks if it is a valid NIFisNIF("06672804K"); //=> true// checks if it is a valid NIEisNIE("X1302311M"); //=> true// returns the control letter in upper casectrlChar("X1302311M"); //=> 'M'ctrlChar("X1302311"); //=> 'M'
Generators
NIF
import { randomNIF, randomNIFWith } from "better-dni";randomNIF(); //=> '31719111H'// returns a valid random NIF given the control letterrandomNIFWith("C"); // => '95652190C'// a seed (Number) can be provided and it will always return the same resultrandomNIFWith("G", 1); //=> '95652174G'randomNIFWith("G", 1); //=> '95652174G'
NIE
import { randomNIE, randomNIEWith } from "better-dni";randomNIE(); //=> 'X1120409X'// returns a valid random NIE given the first and control letterrandomNIEWith("Y", "C"); //=> 'Y2098020C'randomNIEWith("Z", "G"); //=> 'Z5670557G'// a seed (Number) can be provided and it will always return the same resultrandomNIEWith("X", "E", 1); //=> 'X2080280E'randomNIEWith("X", "E", 1); //=> 'X2080280E'
Normalize
// Returns a "clean" dni string removing spaces, dashes, etc.normalize(" x-9464186_p "); // => "X9464186P"
Benchmark
better-dni does a similar job as other libraries like dni-js, dni-js-validator, and @willowi/validate-nif but better-dni is built with optimization and speed in mind. Take a look at these benchmark results:
yarn && yarn build && yarn benchmark
isValid
lib
method
operations/sec
better-dni
#isValid
10,128,148
3.5x faster
dni-js-validator
#isValid
2,870,822
dni-js
#isValid
2,448,090
@willowi/validate-nif
#validateNif
683,573
ctrlChar / getLetter
lib
method
operations/sec
better-dni
#ctrlChar
10,874,568
5.3x faster
dni-js
#getLetter
2,032,845
dni-js-validator
no method
-
@willowi/validate-nif
no method
-
Benchmark on a MacBook Pro (Retina, 13-inch, Early 2015) - 3,1 GHz Intel Core i7 - 16 GB 1867 MHz DDR3 / Node v10.2.1