Uso

Secuencias personalizadas

Define alfabetos y secuencias de caracteres propios para realizar conversiones entre bases personalizadas.

Además de la secuencia estándar Base 36, puedes definir cualquier alfabeto personalizado instanciando BaseConverterSequence y pasándolo al constructor de BaseConverter.

Crear un convertidor con secuencia propia

La longitud de la secuencia determina la base máxima (maximumBase()) que el convertidor podrá utilizar.

custom-sequence.ts
import { BaseConverter, BaseConverterSequence } from '@nodecfdi/base-converter';

// Secuencia únicamente de letras (A = 0, B = 1, C = 2, ..., Z = 25)
const lettersSequence = new BaseConverterSequence('ABCDEFGHIJKLMNOPQRSTUVWXYZ');
const converter = new BaseConverter(lettersSequence);

console.log(converter.maximumBase()); // 26

const input = 'FABACADAEAFAGAH';
const result = converter.convert(input, 8, 16);

console.log(result); // "BEBAIDBAFBIH"
En una secuencia personalizada, el primer carácter representa siempre el valor cero (0), el segundo carácter representa el 1, y así sucesivamente.

Reglas de validación de secuencias

Para que una secuencia sea válida en BaseConverterSequence, debe cumplir todas las siguientes condiciones:

  1. Longitud mínima de 2 caracteres: La base mínima soportada es 2.
  2. Solo caracteres de un byte (ASCII): No se permiten caracteres multibyte (como 'Ñ', letras acentuadas o emojis).
  3. Sin caracteres duplicados (insensible a mayúsculas/minúsculas): Internamente la secuencia se normaliza a mayúsculas (toUpperCase()), por lo que 'ABCDabcd' o 'ABCBA' no son válidas.

Validar una secuencia antes de usarla

Puedes comprobar si una cadena es una secuencia válida sin lanzar excepciones utilizando el método estático BaseConverterSequence.isValid():

validate-sequence.ts
import { BaseConverterSequence } from '@nodecfdi/base-converter';

console.log(BaseConverterSequence.isValid('0123456789ABCDEF')); // true
console.log(BaseConverterSequence.isValid('abc')); // true (se convierte a "ABC")

// Inválidas:
console.log(BaseConverterSequence.isValid('0')); // false (menos de 2 caracteres)
console.log(BaseConverterSequence.isValid('ABCDabcd')); // false (caracteres repetidos al pasar a mayúsculas)
console.log(BaseConverterSequence.isValid('0123Ñ')); // false (contiene carácter multibyte)
Si intentas convertir un número que contiene caracteres no incluidos dentro del subconjunto de la base origen (0 hasta frombase - 1), converter.convert() lanzará un error Error: The number to convert contains invalid characters.