Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fdograph/rut-utilities
@fdograph/rut-utilities - Utility functions to parse, validate and generate a Chilean R.U.T.
https://github.com/fdograph/rut-utilities
chile chilean javascript npm npm-package rut rut-utilities typescript
Last synced: about 2 months ago
JSON representation
@fdograph/rut-utilities - Utility functions to parse, validate and generate a Chilean R.U.T.
- Host: GitHub
- URL: https://github.com/fdograph/rut-utilities
- Owner: fdograph
- License: apache-2.0
- Created: 2020-01-20T19:13:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:39:58.000Z (over 1 year ago)
- Last Synced: 2024-11-06T02:17:12.682Z (about 2 months ago)
- Topics: chile, chilean, javascript, npm, npm-package, rut, rut-utilities, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@fdograph/rut-utilities
- Size: 657 KB
- Stars: 25
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README-es.md
- License: LICENSE
Awesome Lists containing this project
README
# 🇨🇱 Chilean Rut Utilities 🇨🇱
## [:uk: English version](README.md)
---
Tabla de contenidos:
- :uk: English version
- :speech_balloon: Introducción
- :rocket: Cómo empezar
- :wrench: Uso
- :page_facing_up: Licencia
---
## :speech_balloon: Introducción
>Set de funciones utilitarias para generar, procesar y validar un [R.U.T. Chileno](https://es.wikipedia.org/wiki/Rol_%C3%9Anico_Tributario) completamente tipado.
>
>Pensado para desarroladores que deseen interactuar, manipular of validar RUTs.
## :rocket: Cómo empezar
### Npm & Yarn install:
```bash
$ npm install @fdograph/rut-utilities
$ yarn add @fdograph/rut-utilities
```
## :wrench: Uso
> `validateRut(rut?: string, noSuspicious = true) => boolean`
Retorna `true` si el `string` dado corresponde a un R.U.T. válido. Esto es una cadena con forma de R.U.T. que pase la validacion de un patron the R.U.T. y que ademas pase la validacion hecha por el algoritmo matematico oficial y que no tenga el patron the un R.U.T. "sospechoso", estos son R.U.T. que se conforman por el mismo número repetido. Ejemplos: `44.444.444-4`, `22.222.222-2`, `3.333.333-3`, `9999999-9`
```typescript
import { validateRut } from '@fdograph/rut-utilities';
validateRut('18585543-0');
> true
validateRut('18.585.543-0');
> true
validateRut('9.999.999-9');
> false
```
Para evitar la validación de RUTs "sospechosos" es posible pasarle al método el segundo argumento como `false`. Esto cambiará el comportamiento por defecto y la validación solo tomará en cuenta el patrón de RUT básico y la validacion por el algoritmo oficial.
```typescript
import { validateRut } from '@fdograph/rut-utilities';
validateRut('18585543-0', false);
> true
validateRut('18.585.543-0', false);
> true
validateRut('9.999.999-9', false);
> true
validateRut('44.444.444-4', false);
> true
```
---
> `validateRutList(ruts: Iterable, noSuspicious = true) => Map`
Retorna un [Mapa](https://developer.mozilla.org/es/docs/Web/JavaScript/Referencia/Objetos_globales/Map) que contendrá el resultado de la validación indexada en base a cada rut.
```typescript
import { validateRutList } from '@fdograph/rut-utilities';
const validRuts = ['7775735-k', '18585543-0', '18348353-6'];
const result = validateRutList(validRuts);
result.get('7775735-k');
> true
result.get(validRuts[1]);
> true
```
---
> `formatRut(rut?: string, format?: RutFormat = RutFormat.DASH) => string`
Da formato a una cadena con `forma de rut` (Ej: `"33.333.333-3"`) de acuerdo al valor del parámetro `format`. En el caso de que `rut` tenga un patrón no válido se retornará la cadena intacta.
```typescript
enum RutFormat {
DOTS,
DASH,
DOTS_DASH
}
```
```typescript
import { formatRut, RutFormat } from '@fdograph/rut-utilities';
formatRut('44.333.222-1');
> '44333222-1'
formatRut('44333222-1', RutFormat.DOTS_DASH);
> '44.333.222-1'
formatRut('44333222-1', RutFormat.DOTS);
> '44.333.2221'
formatRut('jg7gk-1', RutFormat.DOTS);
> 'jg7gk-1'
```
---
> `deconstructRut(rut: string) => DeconstructedRut`
Descompone un cadena con forma de RUT y retorna un objeto con los valores `digits` y `verifier`
```typescript
type DeconstructedRut = {
digits: string;
verifier: string;
}
```
```typescript
import { deconstructRut } from '@fdograph/rut-utilities';
const { digits, verifier } = deconstructRut('7775735-k');
console.log(digits);
> '7775735'
console.log(verifier);
> 'k'
```
---
Puedes revisar el set completo de functiones utilitaria en los [Tests](src/tests/main.test.ts)
## :page_facing_up: License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.