Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [20.x, 22.x]
node-version: [22.x, 24.x]
steps:
- uses: actions/checkout@v6
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v6
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: yarn install --frozen-lockfile
- run: yarn build
- run: npm ci
- run: npm run build
- name: Run the tests 👀
run: yarn test
run: npm test
- name: Verify that documentation can be created 📖
run: yarn generate-html-docs
run: npm run generate-html-docs
6 changes: 3 additions & 3 deletions .github/workflows/create-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ jobs:

- name: Install and Build 🔧
run: |
yarn install --frozen-lockfile
yarn build
yarn generate-html-docs
npm ci
npm run build
npm run generate-html-docs
ls -ltur html

- name: Deploy 🚀
Expand Down
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# norwegian-national-id-validator

[![Travis build status](https://travis-ci.org/mikaello/norwegian-national-id-validator.svg?branch=master)](https://travis-ci.org/mikaello/norwegian-national-id-validator)
[![npm](https://img.shields.io/npm/v/norwegian-national-id-validator.svg?style=flat-square)](https://www.npmjs.com/package/norwegian-national-id-validator)

Validate Norwegian national identity numbers ([birth number](https://en.wikipedia.org/wiki/National_identification_number#Norway) ([fødselsnummer](https://no.wikipedia.org/wiki/F%C3%B8dselsnummer)), D-number, H-number and FH-number).

The NPM module is ES5, but TypeScript and Flow types is also exported. Types for Flow is generated with [Flowgen](https://github.com/joarwilk/flowgen).

## Installation

Install the package via `npm`:
Expand All @@ -15,12 +12,6 @@ Install the package via `npm`:
npm install --save norwegian-national-id-validator
```

or

```
yarn add norwegian-national-id-validator
```

## Usage

This package exports a functional and object-oriented API for your convenience.
Expand All @@ -32,39 +23,40 @@ import { NorwegianId } from 'norwegian-national-id-validator';

const validation = NorwegianId('29029600013');

console.log(validation.isValid())
console.log(validation.isValid());
// => true

console.log(validation.isBirthNumber())
console.log(validation.isBirthNumber());
// => true

console.log(validation.isDNumber())
console.log(validation.isDNumber());
// => false

console.log(validation.isHNumber())
console.log(validation.isHNumber());
// => false

console.log(validation.isFhNumber())
console.log(validation.isFhNumber());
// => false

console.log(validation.isMale())
console.log(validation.isMale());
// => false

console.log(validation.isFemale())
console.log(validation.isFemale());
// => true

console.log(validation.age())
console.log(validation.age());
// => 24

console.log(validation.birthDate())
console.log(validation.birthDate());
// => Thu Feb 29 1996 [...]
```

### Functional API

#### validateNorwegianIdNumber(value)

This function checks if the given value is a valid Norwegian national identity number. Returns `true` for valid, and `false` for invalid ID-number.
This function checks if the given value is a valid Norwegian national identity number.
Returns `true` for valid, and `false` for invalid ID-number.

**Examples**

Expand Down Expand Up @@ -98,7 +90,7 @@ possibleAgeOfPersonWithIdNumber('03110175225');

## Documentation

Apart from this README, you can find details and examples of using the SDK in the following places:
Apart from this README, you can find details and examples of using the SDK in the following places:

- [SDK Documentation](docs/README.md)
- [Examples](examples/)
Expand Down
160 changes: 0 additions & 160 deletions export.flow.js

This file was deleted.

Loading