id-pl/README.md

Provides utility methods to validate and generate various identification numbers used in Poland such as NIP, REGON, PESEL, etc.

# id-pl

> Provides utility methods to validate and generate various identification numbers used in Poland such as:
> * [NIP](https://pl.wikipedia.org/wiki/NIP)
> * [REGON](https://pl.wikipedia.org/wiki/REGON)
> * [PESEL](https://pl.wikipedia.org/wiki/PESEL)
> * [Identity card number](https://en.wikipedia.org/wiki/Polish_identity_card)
> * [Passport number](https://pl.wikipedia.org/wiki/Paszporty_w_Polsce)

[![Build Status](https://travis-ci.org/SOFTWARE-CLINIC/id-pl.svg?branch=master)](https://travis-ci.org/SOFTWARE-CLINIC/id-pl)
[![npm version](https://badge.fury.io/js/id-pl.svg)](http://badge.fury.io/js/id-pl)
[![Dependency Status](https://david-dm.org/SOFTWARE-CLINIC/id-pl.svg)](https://david-dm.org/SOFTWARE-CLINIC/id-pl)
[![Code Climate](https://codeclimate.com/github/SOFTWARE-CLINIC/id-pl/badges/gpa.svg)](https://codeclimate.com/github/SOFTWARE-CLINIC/id-pl)
[![Test Coverage](https://codeclimate.com/github/SOFTWARE-CLINIC/id-pl/badges/coverage.svg)](https://codeclimate.com/github/SOFTWARE-CLINIC/id-pl/coverage)

## Installation

```bash
$ npm install id-pl --save --save-exact
```

## Quick Start

```js
const {
  PESEL,
  REGON,
  IdentityCardNumber,
  PassportNumber
} = require('id-pl');

expect(PESEL.isValid('83071503434')).to.be.true;
expect(REGON.isValid('975124224')).to.be.true;
expect(IdentityCardNumber.isValid('ABA300000')).to.be.true;
expect(PassportNumber.isValid('CC7999486')).to.be.true;
```