Skip to content

runner

luau
local runner = require("@std/test/runner")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

EntryDescription
runRuns all test cases and suites in env, executing lifecycle hooks around each case. Returns the aggregate results.
runRegisteredTestsRuns all globally registered tests, prints the results with the simple reporter, then exits the process with code 0 on success or 1 on failure.

Functions and Properties

runner.run

Runs all test cases and suites in env, executing lifecycle hooks around each case. Returns the aggregate results.

luau
(env: TestEnvironment, runOptions: types.TestRunnerOptions?) -> TestRunResult

runner.runRegisteredTests

Runs all globally registered tests, prints the results with the simple reporter, then exits the process with code 0 on success or 1 on failure.

luau
() -> ()