idnumbers
    Preparing search index...

    Function register

    • Register countries so the validation API can use them.

      Pass the country definition exported by each idnumbers/countries/<iso3> module. Registering a country that is already registered is a no-op, so this is safe to call from several places, or alongside the root idnumbers entry.

      Parameters

      Returns void

      Error if a key or alias is already registered for a different validator.

      import { register, validateNationalId } from 'idnumbers/core';
      import { country as taiwan } from 'idnumbers/countries/twn';

      register(taiwan);
      validateNationalId('TWN', 'A123456789').isValid; // true