https://github.com/kaangokdemir/turkish-id-checker
A Turkish National Id Checking package which created for developers to use in their form elements or any spesific usage.
https://github.com/kaangokdemir/turkish-id-checker
Last synced: about 2 months ago
JSON representation
A Turkish National Id Checking package which created for developers to use in their form elements or any spesific usage.
- Host: GitHub
- URL: https://github.com/kaangokdemir/turkish-id-checker
- Owner: kaangokdemir
- Created: 2020-01-11T08:47:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T14:29:15.000Z (about 2 years ago)
- Last Synced: 2025-03-15T07:40:29.785Z (2 months ago)
- Language: TypeScript
- Homepage: https://id-checker.netlify.com/
- Size: 1.34 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Turkish National ID Checker
[](https://opensource.org/licenses/MIT) [](https://www.npmjs.org/package/turkish-id-checker) [](https://www.npmjs.com/package/turkish-id-checker) [](https://www.npmjs.com/package/turkish-id-checker)
This is a simple Turkish National Id Checking package which created for developers to use in their form elements or any spesific usage.
## Installation
```bash
npm i turkish-id-checker
```
## Usage
```javascript
let { checkId, generateId } = require('turkish-id-checker')
// Parameter should be a String or a Number
checkId('15973515680') // Returns an Object with status and display keys in it.
checkId('15973515680').status // Returns true
checkId(15973515680).display // Returns 'This is a valid Turkish National ID'
generateId() // Returns a random Turkish National ID
```
## Live Demo
Visit [Live Demo](https://id-checker.netlify.com/)
## Testing
```bash
npm run test
```
## Build
```bash
npm run build
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
## Contributors
Kaan Gökdemir - Author ([@kaangokdemir](https://twitter.com/kaangokdemir)) - [kaangokdemir.com](https://kaangokdemir.com)
## License
ISC