Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moeriki/be-nrn
Belgian NRN (National Registry Number) utility functions
https://github.com/moeriki/be-nrn
Last synced: 22 days ago
JSON representation
Belgian NRN (National Registry Number) utility functions
- Host: GitHub
- URL: https://github.com/moeriki/be-nrn
- Owner: moeriki
- Created: 2019-04-11T08:19:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T23:14:06.000Z (over 3 years ago)
- Last Synced: 2024-12-21T23:36:08.949Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 1.52 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# be-nrn
Belgian NRN (National Registry Number) utility functions.
[](https://travis-ci.org/Moeriki/be-nrn) [](https://coveralls.io/github/Moeriki/be-nrn?branch=master) [](https://david-dm.org/moeriki/be-nrn) [](https://img.shields.io/npm/v/be-nrn.svg)
## Quick start
```sh
npm install be-nrn
```
```js
import { getAge } from 'be-nrn';
getAge('860814 000 00'); // => 32 (at time of writing)
```
## API
**NOTE:** All NRN input strings are normalized
### `getAge(nrn: string, options): number`
Get the age of a citizen's NRN.
```js
getAge('860814 000 00'); // => 32 (at time of writing)
```
Age calculation is based on midnight in the Brussels timezone, regardless of the timezone in which the code is run.
#### options
- `comparisonDate: Date` – get the age on a specific date
### `getBirthDate(nrn: string): Date`
Get the birth date of a citizen's NRN.
```js
getBirthDate('860814 000 00'); // => 1986-08-13T22:00:00.000Z
```
The birth date's time is set to midnight in the Brussels timezone, regardless of the timezone in which the code is run.
### `isBiologicalFemale(nrn: string): boolean`
Determine if the biological birth gender of a citizen's NRN is female.
```js
isBiologicalFemale('860814 000 00'); // => true
```
### `isBiologicalMale(nrn: string): boolean`
Determine if the biological birth gender of a citizen's NRN is male.
```js
isBiologicalMale('860814 001 00'); // => true
```
### `isBirthDateKnown(nrn: string): boolean`
Determine if the birthdate is known. It is possible (eg. for migrated people) to have an unknown date of birth.
```js
isBirthdateKnown('860814 001 00'); // => true
isBirthdateKnown('002000 001 00'); // => false
```
### `isBisNumber(nrn: string): boolean`
Determine if an NRN number is also a BIS number.
```js
isBisNumber('860814 001 00'); // => false
isBisNumber('862814 001 00'); // => true
```
### `isEqual(nrn1: string, nrn2: string): boolean`
Compare two NRN's for equality.
```js
isEqual('860814 000 00', '86.08.14-000.00'); // => true
```
### `isGenderKnown(nrn: string): boolean`
Determine if the gender is known. It is possible (eg. for migrated people) to have an unknown gender.
```js
isGenderKnown('860814 000 00'); // => true
isGenderKnown('862814 000 00'); // => false
isGenderKnown('864814 000 00'); // => true
```
### `isLegalAdult(nrn: string): boolean`
Determine if a citizen is legal adult.
```js
isLegalAdult('860814 000 00'); // => true
```
### `normalize(nrn: string): string`
Used internally for normalizing nrn strings. All we do is remove non-numeric characters.
```js
normalize('86.08.14-000.84'); // => 86081400084
normalize('860814 000 84'); // => 86081400084
```
### `parse(nrn: string): Nrn`
Used internally for parsing nrn strings. The resulting object can be used as input for all other functions.
```js
parse('86.08.14-000.84');
// => { birthDate: '860814', serial: '000', checksum: '84' }
```