Skip to content

sexyoung/id-card-helper

Repository files navigation

Build Status Code Climate codecov npm version Readme Score

id-card-helper is a plugin for check ID or generate random ID. Currently it support Taiwan ID.

Features

  • Singopore
  • Hong Kong

Prepare

  • yarn
  • node

Installing id-card-helper

yarn add id-card-helper

Using id-card-helper

import IDCardHelper from 'id-card-helper';

/* Create a id Checker */
const taiwanCard = new IDCardHelper('Taiwan');

/* Checking ID is valid */
taiwanCard.check('A123456789'); // => true

/* Generate random ID */
taiwanCard.generate(); // =>  'A123456789'

/* Generate Taipei Area ID */
taiwanCard.generate({ area: 'A' }); // =>  'A123456789'

/* Generate female ID */
taiwanCard.generate({ gender: 'female' }); // => 'X280697928To'

/* Generate 5 ID */
taiwanCard.generate({ count: 5 });
// => ['L189927266', 'Z156906740', 'D233324744', 'C121315321', 'R254875676']

/* Or you can combine parameters */
taiwanCard.generate({
  area: 'A',
  gender: 'female'
  count: 3,
}); // => ['A292888280', 'A276501402', 'A28447038']