error

Uma Ferramenta Sumor Cloud.
Mais Documentação

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 Node.JS na versão 16.x ou superior

Requer módulo ES do Node.JS

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

{
  "type": "module"
}

Uso

Definir Erro

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'Usuário não encontrado',
    USER_EXISTED: 'Usuário {name} existente'
  }
})

throw new MyError('USER_NOT_FOUND')
// saída: Error: Usuário não encontrado

throw new MyError('USER_EXISTED', { name: 'Alice' })
// saída: Error: Usuário Alice existente

Multilíngue

import defineError from '@sumor/error'

const MyError = defineError({
  language: 'en', // idioma padrão
  code: {
    USER_NOT_FOUND: 'Usuário não encontrado',
    USER_EXISTED: 'Usuário {name} existente'
  },
  i18n: {
    zh: {
      USER_NOT_FOUND: 'Usuário não encontrado',
      USER_EXISTED: 'Usuário {name} existente'
    }
  }
})

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

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

Converter Erro para JSON

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'Usuário não encontrado',
    USER_EXISTED: 'Usuário {name} existente'
  }
})

const error = new MyError('USER_EXISTED', { name: 'Alice' })
console.log(error.json())
// saída: {"code":"USER_EXISTED","message":"Usuário Alice existente"}

Erro Subjacente

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Falha na verificação do campo',
    FIELD_CANNOT_EMPTY: 'Campo {name} não pode estar vazio',
    FIELD_TOO_LONG: 'Campo {name} é muito longo'
  },
  i18n: {
    zh: {
      FIELD_VERIFY_FAILED: 'Falha na verificação do campo',
      FIELD_CANNOT_EMPTY: 'Campo {name} não pode estar vazio',
      FIELD_TOO_LONG: 'Campo {name} é muito longo'
    }
  }
})

const error = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'username' }),
  new MyError('FIELD_TOO_LONG', { name: 'password' })
])

console.log(error.json())
/* 
saída: 
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Campo username não pode estar vazio"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Campo password é muito longo"
    }
  ]
}
*/

error.language = 'zh'
console.log(error.json())
/*
saída:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Campo username não pode estar vazio"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Campo password é muito longo"
    }
  ]
}
*/

Combinar Erro Padrão

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Falha na verificação do campo',
    FIELD_CANNOT_EMPTY: 'Campo {name} não pode estar vazio',
    FIELD_TOO_LONG: 'Campo {name} é muito longo'
  }
})

const error = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'username' }),
  new MyError('FIELD_TOO_LONG', { name: 'password' }),
  new Error('Erro Desconhecido')
])

console.log(error.json())
/*
saída:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Falha na verificação do campo",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Campo username não pode estar vazio"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Campo password é muito longo"
    },{
      "code":"UNKNOWN_ERROR",
      "message":"Erro Desconhecido"
    }
  ]
}
 */