erro

Uma Ferramenta Sumor Cloud.
Documentação Adicional Uma biblioteca de tratamento de erros que suporta vários idiomas, códigos de erro predefinidos e passagem de dados.

Instalação

npm i @sumor/error --save

Pré-requisitos

Versão do Node.JS

Requer a versão 18.x ou superior do Node.JS.

Requer ES module do Node.JS

Como este pacote é escrito em módulo ES, por favor altere o seguinte código no seu arquivo package.json:

{
  "type": "module"
}

Uso

Definir Erro

import defineError from '@sumor/error'

const MeuErro = defineError({
  code: {
    USUÁRIO_NÃO_ENCONTRADO: 'Usuário não encontrado',
    USUÁRIO_EXISTE: 'Usuário {name} existente'
  }
})

throw new MeuErro('USUÁRIO_NÃO_ENCONTRADO')
// saída: Error: Usuário não encontrado

throw new MeuErro('USUÁRIO_EXISTE', { name: 'Alice' })
// saída: Error: Usuário Alice existente

Multi-idioma

import defineError from '@sumor/error'

const MeuErro = defineError({
  language: 'en', // idioma padrão
  code: {
    USUÁRIO_NÃO_ENCONTRADO: 'Usuário não encontrado',
    USUÁRIO_EXISTE: 'Usuário {name} existente'
  },
  i18n: {
    zh: {
      USUÁRIO_NÃO_ENCONTRADO: 'Usuário não encontrado',
      USUÁRIO_EXISTE: 'Usuário {name} existe'
    }
  }
})

const erro = new MeuErro('USUÁRIO_EXISTE', { name: 'Alice' })
erro.language = 'en' // alterar idioma do erro
console.log(erro)
// saída: Error: Usuário Alice existente

erro.language = 'zh' // alterar idioma do erro
console.log(erro)
// saída: Error: Usuário Alice existe

Converter Erro para JSON

import defineError from '@sumor/error'

const MeuErro = defineError({
  code: {
    USUÁRIO_NÃO_ENCONTRADO: 'Usuário não encontrado',
    USUÁRIO_EXISTE: 'Usuário {name} existente'
  }
})

const erro = new MeuErro('USUÁRIO_EXISTE', { name: 'Alice' })
console.log(erro.json())
// saída: {"code":"USUÁRIO_EXISTE","message":"Usuário Alice existente"}

Erro Subjacente

import defineError from '@sumor/error'

const MeuErro = defineError({
  code: {
    FALHA_VERIFICAÇÃO_CAMPO: 'Falha na verificação do campo',
    CAMPO_NÃO_PODE_VAZIO: 'Campo {name} não pode ser vazio',
    CAMPO_LONGO_DEMAIS: 'Campo {name} é muito longo'
  },
  i18n: {
    zh: {
      FALHA_VERIFICAÇÃO_CAMPO: 'Falha na verificação do campo',
      CAMPO_NÃO_PODE_VAZIO: 'Campo {name} não pode ser vazio',
      CAMPO_LONGO_DEMAIS: 'Campo {name} é muito longo'
    }
  }
})

const erro = new MeuErro('FALHA_VERIFICAÇÃO_CAMPO', {}, [
  new MeuErro('CAMPO_NÃO_PODE_VAZIO', { name: 'username' }),
  new MeuErro('CAMPO_LONGO_DEMAIS', { name: 'password' })
])

console.log(erro.json())
/* 
saída: 
{
  "code":"FALHA_VERIFICAÇÃO_CAMPO",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"CAMPO_NÃO_PODE_VAZIO",
      "message":"Campo username não pode ser vazio"
    },{
      "code":"CAMPO_LONGO_DEMAIS",
      "message":"Campo password é muito longo"
    }
  ]
}
*/

erro.language = 'zh'
console.log(erro.json())
/*
saída:
{
  "code":"FALHA_VERIFICAÇÃO_CAMPO",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"CAMPO_NÃO_PODE_VAZIO",
      "message":"Campo username não pode ser vazio"
    },{
      "code":"CAMPO_LONGO_DEMAIS",
      "message":"Campo password é muito longo"
    }
  ]
}
*/

Combinar Erro Padrão

import defineError from '@sumor/error'

const MeuErro = defineError({
  code: {
    FALHA_VERIFICAÇÃO_CAMPO: 'Falha na verificação do campo',
    CAMPO_NÃO_PODE_VAZIO: 'Campo {name} não pode ser vazio',
    CAMPO_LONGO_DEMAIS: 'Campo {name} é muito longo'
  }
})

const erro = new MeuErro('FALHA_VERIFICAÇÃO_CAMPO', {}, [
  new MeuErro('CAMPO_NÃO_PODE_VAZIO', { name: 'username' }),
  new MeuErro('CAMPO_LONGO_DEMAIS', { name: 'password' }),
  new Error('Erro Desconhecido')
])

console.log(erro.json())
/*
saída:
{
  "code":"FALHA_VERIFICAÇÃO_CAMPO",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"CAMPO_NÃO_PODE_VAZIO",
      "message":"Campo username não pode ser vazio"
    },{
      "code":"CAMPO_LONGO_DEMAIS",
      "message":"Campo password é muito longo"
    },{
      "code":"ERRO_DESCONHECIDO",
      "message":"Erro Desconhecido"
    }
  ]
}
 */