@cristiansantana/chile-rut
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

Chile-Rut

Build status

Chile-Rut is a Javascript (Typescript ready) package for working with the Chilean identification number (known as RUT or RUN).

Features

  • Validate a RUT (Chilean identification number) using its check digit.
  • Obtain the check digit for a RUT.
  • Verify if the format of a RUT is correct.

Installation

npm install @cristiansantana/chile-rut

Usage

Get CheckDigit

Use the getCheckDigit function with a RUT Id as parameter.

Example without format validation

import { getCheckDigit } from "@cristiansantana/chile-rut";

const rutId = "12345678";

try {
    const digit = getCheckDigit(rutId);
    console.log(digit); // -> output expected: 5
} catch (error) {
    // Error: rutId has non valid format
    // ...   
}

Example with format validation

import { getCheckDigit, validateRutIdFormat } from "@cristiansantana/chile-rut";

const rutId = "12345678";

if (validateRutIdFormat(rutId)) {
    const digit = getCheckDigit(rutId);
    console.log(digit); // -> output expected: 5
}
else {
    // Error: rutId has non valid format
    // ...
}

Supported formats

getCheckDigit support the parameter rutId as:

  • "12345678"
  • "12.345.678"
  • "12,345,678"
  • "012.345.678"

Validate a RUT

Use the validateRut function with a RUT as parameter for validate it. This function does not test/verify the actual existence of the RUT, it only checks that it is well-formed

import { validateRut } from "@cristiansantana/chile-rut";

console.log(validateRut("12345678-5")); // -> output expected: true
console.log(validateRut("12345678-6")); // -> output expected: false

Supported formats

validateRut support the parameter rut as:

  • "12345678-5" <- without thousands separator
  • "12.345.678-5" <- dots as the thousands separator
  • "12,345,678-5" <- commas as the thousands separator
  • "012345678-5" <- leading with zeros (also work with thousands separator)

Package Sidebar

Install

npm i @cristiansantana/chile-rut

Weekly Downloads

19

Version

1.0.7

License

ISC

Unpacked Size

19.3 kB

Total Files

23

Last publish

Collaborators

  • cristiansantana