console

Minimal library for capturing and replaying console output

Status

Experimental: Functionality may change for any reason, without semantic versioning guarantees

This module is preloaded. You can simply require it:

local console = require("console")

Starts capturing all regular console output that would normally be printed, buffering it internally. Appends \n to each token.

Currently only captures print, but not io.write. Mainly useful for writing unit tests for user-facing code, or producing delayed output.

Stops capturing console output, allowing it to be displayed normally again. Returns the contents of the internal buffer and then resets it.

Available since: v0.0.1

Starts a console timer with the given label, saving the current (high-resolution) time to mark the beginning of a measured code block.

This is a lightweight helper that takes a snapshot in time when called; it doesn't actually start a "real" (libuv/OS) timer.

Available since: v0.0.7

Stops the console timer with the given label if it exists, marking the end of a measured code block.

The computed time delta is returned, but also reported to the console in a human-readable (but otherwise unspecified) format.

Available since: v0.0.7

Arguments
#	Name	Type	Fallback
	label	string

Return values
#	Name	Type
	elapsedTimeInMilliseconds	number

Version	What happened?
v0.0.7	Added `startTimer` and `stopTimer`
v0.0.1	Initial release