@sfd-br/util

v1.1.20

Published

2 years ago

SFD Utils

Downloads

0High
0Medium
0Low

Installing

npm install @sfd-br/util

Error Messages

In most Rest Services projects, error messages are not handled with adequate standardization. To do this, the library provides an RFC-based error message standardization mechanism RFC-7807.

Example

The message file needs to be a YAML File like:

types:
  - transfer:
      type_code: 1000
      type: <URI>
      title: Transfer Error
      instances:
        - insufficient_funds:
            instance_code: 1
            instance: <URI>#insufficient_funds
            detail: You attempted to make a ${value} transfer, but your balance is ${balance}
        - blocked_account:
            instance_code: 2
            instance: <URI>#blocked_account
            detail: Your account ${account} is locked

Your file need to start with the types (array) key and the child elements
You can give a name for any type of your preference. In our example the name is transfer
Inside the type transfer you must declare a few attributes like:
- type_code (number): It represents a global error specifically about the type. In our example every transfer error.
- type (string): It represents the type URI.
- title (string): Error title.
- instances (array): Instances are the problems with a high granularity. Each instance have a name of your preference. In our example the names are insufficient_funds and blocked_account. Instances have a few attributes like:
  - instance_code (number): It represents a specific error.
  - instance (string): It represents the instance URI. This URI is specific for each detailed problem.
  - detail (string): Detailed message.

Configuration

The configuration is provided by the Config Object, setup method. This method accept some options in JSON format.

For example:

const { Config } = require('@sfd-br/util');

Config.setup({
    yaml: { filePath: <YAML_FILE_PATH>.yaml },
    logger: { name: 'ServiceName', level: 'debug', module: module }
});

YAML Error Messages Options

If you need to standardlize your error messages, you should use and initialize the configuration with the following parameters:

filePath: YAML File Path that define the error messages.

Log Options

If you need to standardlize your error messages, you should use and initialize the configuration with the following parameters:

level: Log level.
name: Service name for the log.

API

Config

This module is responsible to start the configuration for standard Error Message and Log.

const { Config } = require('@sfd-br/util');

Error Message

Config.setup({
    yaml: { filePath: <YAML_FILE_PATH>.yaml }
});

Log

Config.setup({
    logger: { name: 'ServiceName', level: 'debug', module: module, jsonFormat: false }
});

Logger

This module provide the Log methods.

If you don't pass options configuration for LOG in the Config.setup, the module Logger will be started with Log level: 'error', name: 'service', module: undefined and jsonFormat: false.

const { Logger } = require('@sfd-br/util');

Constants

Logger module has a few constants, and the values are:

Logger.LOG_LEVEL.TRACE = 'verbose'
Logger.LOG_LEVEL.DEBUG = 'debug'
Logger.LOG_LEVEL.INFO = 'info'
Logger.LOG_LEVEL.WARN = 'warn'
Logger.LOG_LEVEL.ERROR = 'error'
Logger.LOG_LEVEL.FATAL = 'fatal'

Methods

Logger module has a few methods, like:

log

Logger.log(Logger.LOG_LEVEL.INFO, 'Info text message.')
Logger.log(Logger.LOG_LEVEL.INFO, 'Info','text','message.') // Many string arguments

| Parameter | Description | (Optional) | | ------ | ------ | ------ | | level (string) | Log level | No | | message (...string) | Message | No |