Instalacion

Instalación

npm i @zeluizr/palta

pnpm add @zeluizr/palta
yarn add @zeluizr/palta

No hay nada más que instalar. El paquete no tiene dependencias en runtime.

Requisitos

requisito	valor
Node en runtime	>= 16
Formatos	ESM y CommonJS
Tipos	incluidos, no hace falta @types/...
Dependencias en runtime	ninguna
sideEffects	false, el bundler puede eliminar lo que no uses

El toolchain de desarrollo pide más que el runtime: vitest 4 exige Node >= 20 y la CI corre en Node 22. Esa diferencia importa en VTEX IO — el paquete instala y corre en Node 16 igual, porque la salida compilada no usa ninguna API exclusiva de versiones nuevas.

Las tres formas de importar

Import raíz

Trae todos los namespaces de país bajo su código de dos letras.

import { br, cl, ar, mx } from '@zeluizr/palta'

br.cpf.format('11144477735')   // '111.444.777-35'

Import por subpath

Cada país tiene su propio punto de entrada. Es la opción más liviana cuando trabajás con uno o dos países.

import { cpf, cnpj, currency, phone, zipcode } from '@zeluizr/palta/br'
import { length, weight, volume } from '@zeluizr/palta/measurements'

cpf.format('11144477735')      // '111.444.777-35'

El subpath es siempre el código de dos letras en minúscula: @zeluizr/palta/br, @zeluizr/palta/cl, @zeluizr/palta/ar, y así con los 23. La lista completa está en Países.

CommonJS

const { br } = require('@zeluizr/palta')
const { cpf } = require('@zeluizr/palta/br')

República Dominicana y la palabra do

do es palabra reservada de JavaScript, así que no puede ser el nombre de un export. En el import raíz el namespace se llama do_; el subpath sigue siendo el normal.

import { do_ } from '@zeluizr/palta'
do_.cedula.format('00113918205')

// o, sin el guion bajo
import { cedula } from '@zeluizr/palta/do'

Tamaño del bundle

Importar por subpath es la manera más directa de cargar solo lo que usás. Con un bundler que hace tree-shaking, el import raíz también funciona bien porque el paquete declara "sideEffects": false.

// carga solamente el módulo de Brasil
import { cpf } from '@zeluizr/palta/br'

// depende del tree-shaking del bundler
import { br } from '@zeluizr/palta'

Verificar la instalación

import { detect } from '@zeluizr/palta'

console.log(detect('111.444.777-35'))
// { country: 'BR', type: 'cpf', valid: true, formatted: '111.444.777-35' }

Siguiente paso: Guía de uso.