spain-id/readme.md

Spanish id documents validator (NIF, CIF, NIE)

# spain-id

## What is this?

A very small library to validate spanish id documents (NIF, CIF, NIE).

From version 1.1.0 there is **TypeScript support**.

## Installation

```bash
npm i spain-id
```

Or with yarn

```bash
yarn add spain-id
```

## Usage

```javascript
// import just what you need
import { validateSpanishId, spainIdType, validDNI, validNIE, validCIF } from 'spain-id'

validateSpanishId('39740191D') // Validates the 3 types of document
spainIdType('39740191D') // 'dni'
validDNI('14741806W') // true
validNIE('X8095495R') // true
validCIF('P4622000J') // true

```

## Build and publish

Run `npm publish`.

## Credits

*Note*: Based on these [algorithms](https://gist.github.com/afgomez/5691823)

CIF validation has been fixed, added TypeScript support, and code style changed.