Referencia de API
BaseConverterSequence
Referencia completa de la clase de objeto de valor BaseConverterSequence para definir y validar alfabetos de conversión.
La clase BaseConverterSequence es un objeto de valor inmutable que encapsula y valida la secuencia de caracteres (alfabeto) empleada por BaseConverter.
Importación
import { BaseConverterSequence } from '@nodecfdi/base-converter';
Constructor
new BaseConverterSequence(sequence)
Crea una nueva secuencia validando primero su contenido mediante BaseConverterSequence.checkIsValid(sequence) y convirtiendo todos sus caracteres a mayúsculas.
- Parámetros:
sequence:string— Cadena con los caracteres únicos de la secuencia (mínimo 2 caracteres ASCII de un solo byte).
- Excepciones (
Error): Lanza un error si la secuencia no cumple con las reglas de validación (vercheckIsValid).
const sequence = new BaseConverterSequence('01234567');
Métodos estáticos
BaseConverterSequence.isValid(value)
Evalúa si una cadena cumple con todas las reglas para ser una secuencia válida sin lanzar excepciones.
- Parámetros:
value:string— Cadena a evaluar.
- Retorna:
boolean—truesi la secuencia es válida,falseen caso contrario.
BaseConverterSequence.isValid('01'); // true
BaseConverterSequence.isValid('010'); // false
BaseConverterSequence.checkIsValid(sequence)
Verifica que la cadena cumpla con los requisitos de una secuencia válida. Si alguna regla falla, lanza una excepción Error.
- Parámetros:
sequence:string— Cadena a verificar.
- Retorna:
void - Excepciones (
Error):'Sequence does not contains enough elements': Si la longitud en bytes es menor a2.'Cannot use multibyte strings in dictionary': Si la longitud en bytes UTF-8 difiere desequence.length(contiene caracteres multibyte).'The sequence has not unique values': Si tras convertir a mayúsculas existen caracteres repetidos.
BaseConverterSequence.checkIsValid('0123456789ABCDEF');
Métodos de instancia
value()
Devuelve la cadena de la secuencia normalizada en mayúsculas.
- Retorna:
string
const sequence = new BaseConverterSequence('abcdef');
console.log(sequence.value()); // "ABCDEF"
toString()
Alias de value() que permite convertir la instancia directamente a cadena de texto.
- Retorna:
string
const sequence = new BaseConverterSequence('01');
console.log(String(sequence)); // "01"
length()
Devuelve la cantidad de caracteres de la secuencia.
- Retorna:
number
const sequence = new BaseConverterSequence('0123456789ABCDEF');
console.log(sequence.length()); // 16
