JavaScript ID Number Toolkit is a collection of validators of identity document number for JavaScript applications.
You can install IDNumber by
-
directly import in browser
<script src="IDNumber.js"></script> <!-- Please edit the URL above. -->
A CDN for this file is available at:
https://unpkg.com/id-number/dist/browser/IDNumber.js
using in node.js or webpack
The library is available at NPM with name
id-number
.You can import it via require.
const IDNumber = require('id-number');
Or in ES6 style.
import IDNumber from 'id-number';
const validator = IDNumber.getValidator('SG', 'NRIC'); const result = validator('S0980292D');
And the result is in format:
{ 'success': true or false, 'reason': string if the result is false }
const generator = IDNumber.getValidator('CN', 'ID'); const result = generator();
And the result is in format:
{ 'value': 466311201110053638, 'extra': {"province":"海南","birthday":"2011-10-05","gender":"Male"} }
Country Document SG (Singapore) NRIC TW (Taiwan) ID (身份證字號) CN (China) ID (居民身份证号码) To build:
npm run build
To test:
npm test
Step 1: Write the validator / generator in TypeScript in the directory
src/providers/<name>.ts
. The validator shall be a function returning aInternalValidateResult
.Step 2: Register the validator / generator in
src/IDNumber.ts
Step 3: Write test cases at
src/<name>.spec.ts
.Step 4: Send a pull request to this repository.
Thank you for the contributions.
The source code for demo website (id-number.dreamrunner.space) locates at the
demo
folder.To deploy, go into
demo
folder and typeyarn deploy
if you have permission.We have a very good wiki that explain the algorithm of the ID number checksum used by different identity documents.
js-id-number's People
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.