Module: ticker-log

ticker-log
On-screen, ticker-tape-style logging tool

http://jonbri.github.io/ticker-log
https://github.com/jonbri/ticker-log
https://www.npmjs.com/package/ticker-log

Author:
Source:

Methods

(inner) config(o)

Overlay object over configuration object.
Only an api function...doesn't map to a key.
Public+private way of setting configuration properties.

Example:
// change log speed to 400
window.ticker.config({
  interval: 400
});
Parameters:
Name Type Description
o object property/value map to apply
Source:

(inner) decreaseLogStartTop()

"pageUp" api function.
Change starting vertical position (logStartTop) for on-screen logs.
Source:

(inner) decreaseSpeed()

"down" api function.
Increase delay interval by adjustmentInterval.
Source:

(inner) dump()

"d" api function.
Show configuration properties in output textarea.
Source:

(inner) filter(matcher)

"filter" api function.
Only an api function...doesn't map to a key.
Parameters:
Name Type Description
matcher regex | string either a string or regex to filter log by
Source:

(inner) flip()

"f" api function.
flip (reverse) order of textarea
Source:

(inner) help()

"h" api function.
Show help text on-screen as logs.
Source:

(inner) increaseLogStartTop()

"pageDown" api function.
Change starting vertical position (logStartTop) for on-screen logs.
Source:

(inner) increaseSpeed()

"up" api function.
Decrease delay interval by half the adjustmentInterval.
Source:

(inner) kill()

"k" api function.
Clear render buffer and remove all ticker log dom elements.
Source:

(inner) killTextarea()

"Esc" api function.
Remove textarea dom element.
Source:

(inner) listenToEverything()

"listenToEverything" api function.
Only an api function...doesn't map to a key.

Listen to all console invocations:
  • all channels
  • regardless if backtick provided
Source:

(inner) macroEdit()

"m" api function.
For macro 9.
Show a textarea where macro can be edited.
"save" macro when textarea is dismissed.
Source:

(inner) moveLeft()

"left" api function.
Change log container position and alignment of log dom elements.
Source:

(inner) moveRight()

"right" api function.
Change log container position and alignment of log dom elements.
Source:

(inner) nextChannel()

"Tab" api function.
Switch to listen to next console channel ("log", "warn", etc).
Order is determined by aChannels.
Source:

(inner) output(bAll)

"o" api function.
Show log text in the "output textarea".
Parameters:
Name Type Description
bAll boolean whether to show all logs ever, OR just the current on-screen ones (default: false)
Source:

(inner) outputAll()

"l" (for "log") api function.
Api function to show all saved log messages.
Source:

(inner) pause()

"p" api function.
Toggle pauseMode config prop boolean.
Source:

(inner) print(text, o)

Print log div to screen.
Only an api function...doesn't map (directly) to a key.

A configuration object can be passed as the second argument:
keyvalue
overrideSilentModestill print, even if silent mode is on
internaldo not track in aBuffer

Example:
// show log on-screen
window.ticker.print('lorum ipsum');

Parameters:
Name Type Description
text string innerHTML for log dom ref
o object configuration object
Source:

(inner) registerMacro(iNumToRegister, fn)

Register (overwrite) macro.
For macros 0-8.
Only an api function...doesn't map to a key.
Parameters:
Name Type Description
iNumToRegister int key in aMacros object to write to
fn function callback function
Source:

(inner) reset()

Reset all settings.
Reverts everything ticker has modified and re-installs from scratch.
Only an api function...doesn't map to a key.
Source:

(inner) restoreAndExit()

"end all ticker operations" api function.
Stop ticker from doing anything.
Reset url param.
Reset console object.
Only an api function...doesn't map to a key.
Source:

(inner) runMacro(iMacroSlot)

"0-9" api function.
Also can be called directly.
Execute macro.
Parameters:
Name Type Description
iMacroSlot int macro in aMacros object to execute
Source:

(inner) saveConfig()

"enter" api function.
Update url (window.location) to "save state".
Only use config props that have changed.
Generate url-friendly, json string to use for "ticker" param.
Source:

(inner) silent()

"s" api function.
Toggle silentMode config prop boolean.
Source:

(inner) test()

"t" api function.
Print out test log (plus date).
Source: