Function

Static Public Summary
public	formatError(error: Error): string Transform an error into a user-readable, colored string.
public	fromEnv(options: Object, env: Object, environment: string): Log Utility function that will create a new instance of `Log` with options taken from environment variables.
public	indent(string: string, length: number, char: string): string Add characters at the begenning of every line of a multi-line string.

Static Public

import {formatError} from 'hiplog/src/index.js'

Transform an error into a user-readable, colored string.

Name	Type	Attribute	Description
error	Error		Input error.

The formatted message.

import {fromEnv} from 'hiplog/src/index.js'

Utility function that will create a new instance of Log with options taken from environment variables.

Variables:

NODE_ENV:
- 'development' (default): displayTime is disabled,
- 'test': displayTime is disabled, 'level' is set to 'critical',
- 'production': Use default values for each option.
LOG: Sets level value.
LOG_LEVEL: Alias for LOG.
LOG_TIME: When set to true or 1, enables displayTime.
LOG_TIME_FORMAT: Sets displayTimeFormat value.

Name	Type	Attribute	Description
options	Object	optional default: {}	Additional options. Will take precedence over other ones.
env	Object	optional default: process.env \|\| {}	`env` object.
environment	string	optional default: env.NODE_ENV \|\| 'development'	Environment.

Log	A new instance of `Log`.

import {indent} from 'hiplog/src/index.js'

Add characters at the begenning of every line of a multi-line string.

Name	Type	Attribute	Description
string	string		Input string.
length	number		Number of characters to insert at every line.
char	string	optional default: ' '	Character to insert.

The indented string.