This framework is used to better display logs on your console or terminal.
This framework using env in node and localStorage in browser for betters performance :
-
LOGLEVEL: To save the log level. So only declaring in one instance, all instance can read that log level. -
LOGFILTERS: To save any instance that can display context on console or terminal (according to the name that was given at the time of initialization). default isall,unamed. -
LOGWARNINGLEVEL: To save the warning level. -
debugorverbose: To showing all level in terminal. -
info: Shows only context with levelinfoon console or terminal. -
error: Shows only context with levelerroron console or terminal. -
warn: Shows only context with levelwarn(warning) on console or terminal. -
none: Will not display anything on console or terminal
const { Logger } = require('@tgsnake/log');
const log = new Logger({
name: 'some-string-without-space-here',
level: ['debug'], // default level for this log
});
log.log('Hello World'); // (name) info - Hello World DD/MM/YY hh:mm:ss.mslog: Print log without template.info: Print log as info level.error: Print log as error level.warning: Print log as warning level.combine: Print log as multiple level.debug: Print log as debug level.setLogLevel: Setting the log level.setWarningLevel: Setting the warning level.hardif you want show the context in all log level,softif you want show the context only inwarningordebugorverboselevel.setFilters: Setting any instance that can display context in the console or terminal.
| parameter | type | description |
|---|---|---|
| name | string | Name of logger instance, default is unamed |
| level | Array of debug, none, info, error, verbose |
The level of the logger. By default it will take the value from the env LOGLEVEL or if it is not available it will automatically go into debug level |
| customColor | Color | Console color customization |
On deno supports chalk v5 customization while on node supports chalk v4 customization. For RGB, HSL (only for node), HSV (only for node), HWB (only for node), you can use the format: format(a,b,c) example rgb(0,0,0) or hsl(0,0,0). And you can directly provide the hex code (eg: #fff). In nodes, you can also use keywords from CSS like orange.
| category | type | description |
|---|---|---|
| name | string | color of logger name |
| date | string | color of date |
| debug | string | color when debug level and verbose level |
| info | string | color when info level |
| error | string | color when error level |
| warning | string | color when warning level |
const { Logger } = require("@tgsnake/log")
const log = new Logger({
name : "some-string-without-space-here",
level : ["debug"] // default level for this log,
customColor : {
debug: 'blue',
info: 'rgb(0,255,0)',
error: '#ff0505',
warning: 'hsv(44,98,100)',
name: 'azure',
date: 'grey',
}
})Build with