UNPKG

pt-id-validator

Version:

Library to perform validation of Portuguese ID documents

github.com/AfonsoFGarcia/PT-ID-Validator

AfonsoFGarcia/PT-ID-Validator

26 lines (15 loc) • 1.49 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
PT-ID-Validator ======================= ![npm](https://img.shields.io/npm/dt/pt-id-validator) This library provides functions to validate the portuguese `Bilhete de Identidade` and `Cartão de Cidadão` number. Usage ----- The module is available in [npm](https://www.npmjs.com/package/pt-id-validator). In order to perform validations, you need to input the ID number accordingly to the description in the [documentation](https://www.autenticacao.gov.pt/documents/20126/115760/Valida%C3%A7%C3%A3o+de+N%C3%BAmero+de+Documento+do+Cart%C3%A3o+de+Cidad%C3%A3o.pdf/) provided by the portuguese government (Portuguese only). Although this description is for `Cartão de Cidadão`, the same applies for `Bilhete de Identidade`, only without the AAT end. The provided function checks the correctness of the number and the format. `check(val)` verifies if the format is valid for either `Cartão do Cidadão` or `Bilhete de Identidade`, according to the format DDDDDDDD C AAT or DDDDDDDD C, respectively. After that, it uses the correct check digit algorithm to verify if it the number is valid. If the number that you want to check has 7 digits instead of 8, you don't need to input the leftmost 0 of the number. The return values are as follows: * `false` if the provided string is not a valid `Cartão do Cidadão`/`Bilhete de Identidade` * `true` if the provided string is a valid `Cartão do Cidadão`/`Bilhete de Identidade` When an incorrect format is passed, a `TypeError` is thrown.