thai-id-validator/README.md

Thai Citizen ID validator with 0 dependencies

# Thai Citizen ID Validator

![thai-citizen-id-validator](https://socialify.git.ci/jukbot/thai-citizen-id-validator/image?description=1&language=1&name=1&owner=1&pattern=Solid&stargazers=1&theme=Light)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d49ee28fb17b476baeb9387e6888b751)](https://app.codacy.com/gh/jukbot/thai-citizen-id-validator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/d49ee28fb17b476baeb9387e6888b751)](https://app.codacy.com/gh/jukbot/thai-citizen-id-validator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[![NPM Download](https://img.shields.io/npm/dt/thai-id-validator.svg)](https://www.npmjs.com/package/thai-id-validator)
[![javascript style guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![npm](https://img.shields.io/npm/v/thai-id-validator.svg)](https://www.npmjs.com/package/thai-id-validator)

A simpler way to validate Thai Citizen Card ID. 🇹🇭

## Minimum Node.js Version ⚠️

This package requires Node.js version 16 or later.

## Future Roadmap

- Go Language Implementation Example
- .NET Language Implementation Example
- Thai Passport Number Validation

## Read the article

[Building Thai Citizen ID Input Validation with WCAG Standard](https://medium.com/@juk/%E0%B8%A5%E0%B8%AD%E0%B8%87%E0%B8%AA%E0%B8%A3%E0%B9%89%E0%B8%B2%E0%B8%87%E0%B8%9F%E0%B8%AD%E0%B8%A3%E0%B9%8C%E0%B8%A1%E0%B8%95%E0%B8%A3%E0%B8%A7%E0%B8%88%E0%B8%AA%E0%B8%AD%E0%B8%9A%E0%B9%80%E0%B8%A5%E0%B8%82%E0%B8%9A%E0%B8%B1%E0%B8%95%E0%B8%A3-%E0%B8%9B%E0%B8%8A%E0%B8%8A-%E0%B8%9E%E0%B8%A3%E0%B9%89%E0%B8%AD%E0%B8%A1%E0%B8%A1%E0%B8%B2%E0%B8%95%E0%B8%A3%E0%B8%90%E0%B8%B2%E0%B8%99-wcag-13b2c8c9d015)

## Installation

```bash
$ npm install thai-id-validator
# or
$ yarn add thai-id-validator
# or
$ pnpm add thai-id-validator
# or
$ bun add thai-id-validator
```

## Data Type

| Input  | Output  |
| ------ | :-----: |
| String | boolean |

## Usage

### Javascript / Typescript

In Javascript, Typescript file, you can use import, export modules

```javascript
import isValidThaiID from 'thai-id-validator';

let result = isValidThaiID(‘1101700207030’);

console.log(result);
// true
```

## Test

To run all test cases run the following command

```bash
bun run test
```

You can edit validator.test.js too add your custom test case.

| Test Cases      | Result |
| --------------- | :----: |
| '1112034563562' |   ✅   |
| '0113200420331' |   ✅   |
| '1101700230705' |   ❌   |
| '110170023073'  |   ❌   |
| '11017002070d3' |   ❌   |
| 'rytege54fsfsf' |   ❌   |
| 0               |   ❌   |
| '-'             |   ❌   |
| ''              |   ❌   |
| null            |   ❌   |
| undefined       |   ❌   |
| 'blablabla'     |   ❌   |

`(Tested with Bun)`

### Test Result Screenshot

 <img src="test-result.png" width="500"/>

### How to upload test coverage report to codacy

```zsh
export CODACY_PROJECT_TOKEN=xxxxxxxxx

bun run coverage

bash <(curl -Ls https://coverage.codacy.com/get.sh)
```

## Compatibility

Tested on all modern browsers ✅

## Issues

If you found any 🐞 or feedback, please report the issue [here](https://github.com/jukbot/thai-citizen-id-validator/issues)

## Contribution

👩🏻‍💻 Contribute are always welcome.

## License

[MIt](https://opensource.org/license/mit)

Code with love 🦉