validador-digito-verificador-chile/app.d.ts

Librería que valida si el rut ingresado es valido, calcula el digito verificador, limpia y formatea run

/**
 * Valida el Digito Verificador del RUN ingresado
 * @param {string} run - Ingresa el run
 * @returns {boolean} Devuelve true cuando es un rut valido, false cuando es invalido y null cuando ocurre un error
 */
export declare function Validar(run: string): boolean;

/**
 * Calcula el Digito verificador de un RUN
 * @param {string} numero - Ingresa el run sin digito verificador
 * @returns {boolean} Devuelve el digito verificador como string y cuando ocurre un error devuelve null
 */
export declare function ObtenerDV(numero: string): boolean;

/**
 * Limpia un RUN
 * @param {string} run - Ingresa el run
 * @returns {object} Devuelve un objeto con el numero y dv
 */
export declare function Limpiar(run: string): object;

/**
 * Limpia un RUN
 * @param {string} run - Ingresa el run con digito verificador
 * @param {boolean} puntos - Si es true agrega . al run final, por defecto es false
 * @returns {string} Devuelve un string con formato 11111111-1 y si puntos es true devuelve 11.111.111-1
 */
export declare function DarFormato(run: string, puntos: boolean): string;

/**
 * Grupo de utilidades para trabajar con RUTs.
 */
declare const dv: {
  DarFormato: typeof DarFormato;
  Limpiar: typeof Limpiar;
  Validar: typeof Validar;
  ObtenerDV: typeof ObtenerDV;
};

export default dv;