RUTility

Chilean RUT Validation and Formatting Library

A library for validating and formatting the Chilean RUT (Rol Único Tributario). This library provides functions to format the RUT with dots and dashes, as well as to validate its format and check digit.

Installation

You can install the library using npm:

npm install rutility

Usage

Import in a Node.js Project

const { format, calculateDv, isValidRut, isFormat } = require('rutility');

Import in an ES6 Module

import { format, calculateDv, isValidRut, isFormat } from 'rutility';

Formatting Functions

format.dot(rut: string): string Formats a RUT by adding dots.

console.log(format.dot('12345678')); // '12.345.678'
console.log(format.dot('12345678-K')); // '12.345.678-K'

format.dash(rut: string): string Formats a RUT by adding a dash.

console.log(format.dash('123456780')); // '12345678-0'
console.log(format.dash('12.345.6780')); // '12.345.678-0'
console.log(format.dash('12')); // '1-2'

format.dotDash(rut: string): string Formats a RUT by adding dots and a dash.

console.log(format.dotDash('123456780')); // '12.345.678-0'
console.log(format.dotDash('12345678-K')); // '12.345.678-K'

format.notDot(rut: string): string Removes dots from a RUT.

console.log(format.notDot('12.345.678-0')); // '12345678-0'
console.log(format.notDot('12.345.678')); // '12345678'

format.notDash(rut: string): string Removes the dash and check digit from a RUT.

console.log(format.notDash('12.345.678-0')); // '12.345.678'
console.log(format.notDash('12345678-0')); // '12345678'

format.notDotDash(rut: string): string Removes dots and the dash from a RUT.

console.log(format.notDotDash('12.345.678-9')); // '12345678'
console.log(format.notDotDash('12.345.678')); // '12345678'

Validation Functions

calculateDv(rut: string | number): string Calculates the check digit of a Chilean RUT.

console.log(calculateDv('12.345.678')); // '5'
console.log(calculateDv('12345678')); // '5'
console.log(calculateDv(12345678)); // '5'

isValidRut(rut: string): boolean Validates if a Chilean RUT is valid.

console.log(isValidRut('12.345.678-5')); // true
console.log(isValidRut('12345678-5')); // true

Format Validations

isFormat.dot(rut: string): boolean Checks if a RUT has the correct format with dots.

console.log(isFormat.dot('12.345.678')); // true

isFormat.dash(rut: string): boolean Checks if a RUT has the correct format with a dash.

console.log(isFormat.dash('12345678-9')); // true

isFormat.dotDash(rut: string): boolean Checks if a RUT has the correct format with dots and a dash.

console.log(isFormat.dotDash('12.345.678-9')); // true

Contributing

If you wish to contribute to this project, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

¡Sigueme en mis redes!