Skip to content

nip24pl/nip24-javascript-client

Repository files navigation

NIP24 Client for JavaScript

This is the official repository for NIP24 Client for JavaScript

This library contains validators for common Polish tax numbers like NIP, REGON and KRS. Validators for EU VAT ID and IBAN are also included. After registration at NIP24 Portal this library could be used for various on-line validations of Polish and EU companies. Please, visit our web page for more details.

Documentation

The documentation and samples are available here.

Build

Node.js 22+ is required to build this library. Building is only required to generate TypeScript definitions.

git clone https://github.com/nip24pl/nip24-javascript-client.git
cd nip24-javascript-client
npm install
npm run build:types

How to use

The release version of the library is published in NPM. Add the following dependency using the npm tool:

npm install nip24client

The example directory contains a sample usage from a Node.js application, and the example-web directory contains a sample usage from an HTML web application.

License

This project is delivered under Apache License, Version 2.0:

  • License (Apache 2.0)