A debug display for Synapse X
Importing with Neon:
synlog = NEON:github('belkworks', 'synlog')
Note: This documentation is UNFINISHED!
Some functions may not be documented.
print: synlog:print(...blocks) -> nil
Print all of blocks
separated with a space.
synlog:print('hello', 'world', 123) -- prints 'hello world 123'
error, warning, info & success: synlog:[method](...blocks) -> nil
Same as print, but prefixes the blocks with a colored tag.
synlog:error('something happened') -- prints 'ERROR something happened'
setDefaultTime: synlog:setDefaultTime(seconds) -> nil
Sets the default duration that logs are shown.
synlog:setDefaultTime(4) -- logs will appear for 4 seconds
Using with logfile
Call the :logger()
method to get a logfile-compatible writer.
file = log.logfile('events.log')
levels = {
system = "WARN",
other = "INFO",
hush = "OFF"
}
combined = log.combine(file, synlog:logger())
log.init(levels, combined)
To create a colored block of text, synlog provides a chalk function.
You can mix and match as many color blocks as you want.
chalk = synlog.chalk
synlog:print('hello', chalk('world').light.red) -- prints 'hello world'
-- 'world' will be light red (light is a modifier)
A list of colors can be found in the source code.