Module guih.lib.log

Logging api used for making logs on terminal objects

Functions

create_log (the[, title[, title_symbol]]) makes a new log in the desired terminal window
log_object (message, type) writes a new message to the log
log_object:dump (path) dumps the log into a file

Fields

log_object.error Error Log type used by the {log_object:log} function
log_object.warn Warn Log type used by the {log_object:log} function
log_object.fatal Fatal Log type used by the {log_object:log} function
log_object.success Success Log type used by the {log_object:log} function
log_object.message Message Log type used by the {log_object:log} function
log_object.update Update Log type used by the {log_object:log} function
log_object.info Info Log type used by the {log_object:log} function


Functions

create_log (the[, title[, title_symbol]])
makes a new log in the desired terminal window

Parameters:

  • the terminal terminal object to make the new log on
  • title string the title to display on the log (optional)
  • title_symbol string the background symbol to use for the title (optional)
log_object (message, type)
writes a new message to the log

Parameters:

  • message string the message to write to the log
  • type number the log type to write the log with (sets the color and style.)
log_object:dump (path)
dumps the log into a file

Parameters:

  • path string the path to the file to dump the log to

Returns:

    string the string written into the said file

Fields

log_object.error
Error Log type used by the {log_object:log} function

See also:

log_object.warn
Warn Log type used by the {log_object:log} function

See also:

log_object.fatal
Fatal Log type used by the {log_object:log} function

See also:

log_object.success
Success Log type used by the {log_object:log} function

See also:

log_object.message
Message Log type used by the {log_object:log} function

See also:

log_object.update
Update Log type used by the {log_object:log} function

See also:

log_object.info
Info Log type used by the {log_object:log} function

See also:

generated by LDoc 1.4.6 Last updated 2022-06-23 16:51:50