![\"npm\"](\"https://img.shields.io/npm/v/@accountable/jsvat.svg?style=flat-square&logo=npm\")
\n \n \n ![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\"){kind=icon}
\n \n \n ![\"GitHub](\"https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square\"){kind=icon}
\n \n@accountable/jsvat
\n\nCheck the validity of the format of a VAT number. No dependencies
\n\n\n## Disclaimer\n\nThis library is a fork of [jsvat](https://github.com/se-panfilov/jsvat) which in no longer maintained and all new pull requests to it are ignored for long time.\n\nSo in [Accountable](https://www.accountable.eu/), we thought it would be great to add support for the new VAT number format and keep the library up to date and easily maintained as it is part of our day to day work.\n\n## What is it?\n\nSmall library to check validity VAT numbers (European + some others counties). ([learn more][1] about VAT)\n\n- Rewritten into Typescript :new:\n- No dependencies\n- No http calls\n- 2-step checks: math + regexp\n- Tree-shakeable\n- Extendable\n- Separate checks for valid VAT and valid VAT format\n- Dynamically add/remove countries with which you want to check the VAT\n- Detecting possible country before you finish\n- Typescript\n\n## Installation\n\nvia **npm**:\n\n```bash\nnpm i @accountable/jsvat\n```\n\nvia **yarn**:\n\n```bash\nyarn add @accountable/jsvat\n```\n\n## Getting Started\n\n- check against specific countries\n\n```javascript\nimport { checkVAT, belgium, austria } from '@accountable/jsvat';\n\ncheckVAT('BE0411905847', [belgium]); // true: accept only Belgium VATs\ncheckVAT('BE0411905847', [belgium, austria]); // true: accept only Belgium or Austria VATs\ncheckVAT('BE0411905847', [austria]); // false: accept only Austria VATs\n```\n\n- check against all supported countries\n\n```javascript\nimport { checkVAT } from '@accountable/jsvat';\n\ncheckVAT('BE0411905847'); // no need to pass countries as all supported countries will be used as default behavior\n```\n\n- check against all supported countries except specific ones\n\n```javascript\nimport { checkVAT, countriesMap } from '@accountable/jsvat';\n\nconst { france, germany, ...countriesToValidate } = countriesMap;\n\ncheckVAT('BE0411905847', countriesToValidate);\n```\n\n## Return value\n\n`checkVAT()` returns `VatCheckResult` object:\n\n```typescript\nexport interface VatCheckResult {\n value?: string; // 'BE0411905847': your VAT without extra characters (like '-', spaces, etc)\n isValid: boolean; // The main result. Indicates if VAT is correct against provided countries or not\n isValidFormat: boolean; // Indicates the validation of the format of VAT only. E.g. \"BE0411905847\" is a valid VAT, and \"BE0897221791\" is not. But they both has valid format, so \"isValidFormat\" will return \"true\"\n isSupportedCountry: boolean; // Indicates if \"jsvat\" could recognize the VAT. Sometimes you want to understand - if it's an invalid VAT from supported country or from an unknown one\n country?: {\n // VAT's country (null if not found). By \"supported\" I mean imported.\n name: string; // ISO country name of VAT\n isoCode: {\n // Country ISO codes\n short: string;\n long: string;\n numeric: string;\n };\n };\n}\n```\n\n## List of supported Countries:\n\n- 🇦🇩 Andorra\n- 🇦🇹 Austria\n- 🇧🇪 Belgium\n- 🇧🇷 Brazil\n- 🇧🇬 Bulgaria\n- ðŸ‡ðŸ‡· Croatia\n- 🇨🇾 Cyprus\n- 🇨🇿 Czech republic\n- 🇩🇰 Denmark\n- 🇪🇪 Estonia\n- 🇪🇺 Europe\n- 🇫🇮 Finland\n- 🇫🇷 France\n- 🇩🇪 Germany\n- 🇬🇷 Greece\n- ðŸ‡ðŸ‡º Hungary\n- 🇮🇪 Ireland\n- 🇮🇹 Italy\n- 🇱🇻 Latvia\n- 🇱🇹 Lithuania\n- 🇱🇺 Luxembourg\n- 🇲🇹 Malta\n- 🇳🇱 Netherlands\n- 🇳🇴 Norway\n- 🇵🇱 Poland\n- 🇵🇹 Portugal\n- 🇷🇴 Romania\n- 🇷🇺 Russia\n- 🇷🇸 Serbia\n- 🇸🇰 Slovakia Republic\n- 🇸🇮 Slovenia\n- 🇪🇸 Spain\n- 🇸🇪 Sweden\n- 🇬🇧 United Kingdom\n- 🇨🇠Switzerland\n\n## Extend countries list - add your own country\n\nYou can add your own country.\nIn general `Country` should implement following structure:\n\n```typescript\ninterface Country {\n name: string;\n codes: ReadonlyArray