@tc-libs/error-interface
v3.6.1
Published
Definisce i contratti TypeScript condivisi per rappresentare errori applicativi e errori di importazione.
Readme
@tc-libs/error-interface
Definisce i contratti TypeScript condivisi per rappresentare errori applicativi e errori di importazione.
Questo package non contiene eccezioni NestJS, filtri o logica runtime: espone solo tipi e costanti riusabili.
Export pubblici
import {
ERROR_TYPE,
IErrors,
IErrorsImport,
IValidationErrorImport,
} from '@tc-libs/error-interface';Tipi disponibili
IErrors
Rappresenta un singolo errore applicativo normalizzato:
type IErrors = {
message: string;
property: string;
};Uso tipico:
const errors: IErrors[] = [
{ property: 'email', message: 'email must be valid' },
];IErrorsImport
Rappresenta un errore associato a una riga di import:
type IErrorsImport = {
row: number;
file?: string;
errors: IErrors[];
};Utile per import massivi da CSV/XLSX dove devi restituire al chiamante il dettaglio per record.
IValidationErrorImport
Variante pensata per interoperare con class-validator:
type IValidationErrorImport = {
row: number;
file?: string;
errors: ValidationError[];
};Enum disponibili
ERROR_TYPE
Classifica il tipo di errore:
ERROR_TYPE.DEFAULT;
ERROR_TYPE.IMPORT;Tipicamente viene usato nei package superiori per differenziare la serializzazione o il trattamento dell'errore.
Quando usarlo
Usa questo package quando vuoi:
- condividere interfacce errore tra librerie
- tipizzare errori di validazione/import senza introdurre dipendenze runtime aggiuntive
- evitare duplicazioni di DTO o interfacce negli handler applicativi
Sviluppo
nx build error-interface
nx test error-interface