JSPM

lt-codes

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 23
  • Score
    100M100P100Q54332F
  • License MIT

Lithuanian codes. Personal & company code validator and generator

Package Exports

  • lt-codes
  • lt-codes/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lt-codes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Lithuanian codes

Personal & company codes validator and generator

Lietuviškų asmens kodo / įmonės kodo tikrinimo bei generavimo funkcijos

Table of Contents

Examples

Examples can be found here:

Instalation

Setup

npm install lt-codes
yarn add lt-codes

Usage

Initialize

import { personalCode, companyCode } from 'lt-codes';

Personal code

Function Description
personalCode.validate(code: string) Validates personal code
personalCode.generate() Generates personal code

Example

const code = '39001010000'; // example
const generatedCode = personalCode.generate();
const { isValid, isException, error } = personalCode.validate(code);

Response (example)

{
  "isValid": true,
  "error": "",
  "isException": true
}

Using Typescript

import { ValidationResult } from 'lt-codes';
const result: ValidationResult = personalCode.validate(code);

Company code

Function Description
companyCode.validate(code: string) Validates company code
companyCode.generate() Generates company code

Example

const code = '123456789'; // example
const generatedCode = companyCode.generate();
const { isValid, isException, error } = companyCode.validate(code);

Response (example)

{
  "isValid": true,
  "error": "",
  "isException": false
}

Using Typescript

import { ValidationResult } from 'lt-codes';
const result: ValidationResult = companyCode.validate(code);

Errors

You can import all error types from lt-codes as use as constants.

import { ValidationError } from 'lt-codes';

error property returned by validate() can be empty or one of the following values:

Value Description
ValidationError.EMPTY Code not passed (empty)
ValidationError.INVALID Do not pass regex checker
ValidationError.INVALID_CONTROL_NUMBER Invalid control number (last digit)
ValidationError.INVALID_DATE Invalid user birth date