Skip to main content

TestManager

This class provides an interface for running tests and benchmarks.

Functions​

run​

</>
TestManager.run(config: TestConfig?) → ()

Types

​

interface TestConfig {
runTests: boolean?--

[Default: true] Whether to run tests.

runBenchmarks: boolean?--

[Default: false] Whether to run benchmarks.

ancestors: {Instance}?--

[Default: {ReplicatedStorage}] The ancestors to search for test and benchmark files.

ignoreList: {string | Instance}?--

A list of strings or instances to ignore when searching for test and benchmark files.

}

Collects .spec and .bench files and then runs the tests and benchmarks.

Show raw api
{
    "functions": [
        {
            "name": "run",
            "desc": "Collects `.spec` and `.bench` files and then runs the tests and benchmarks.",
            "params": [
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "TestConfig?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/testez/src/TestManager.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "TestConfig",
            "desc": "",
            "fields": [
                {
                    "name": "runTests",
                    "lua_type": "boolean?",
                    "desc": "[Default: true] Whether to run tests."
                },
                {
                    "name": "runBenchmarks",
                    "lua_type": "boolean?",
                    "desc": "[Default: false] Whether to run benchmarks."
                },
                {
                    "name": "ancestors",
                    "lua_type": "{Instance}?",
                    "desc": "[Default: {ReplicatedStorage}] The ancestors to search for test and benchmark files."
                },
                {
                    "name": "ignoreList",
                    "lua_type": "{string | Instance}?",
                    "desc": "A list of strings or instances to ignore when searching for test and benchmark files."
                }
            ],
            "source": {
                "line": 31,
                "path": "src/testez/src/TestManager.lua"
            }
        }
    ],
    "name": "TestManager",
    "desc": "This class provides an interface for running tests and benchmarks.",
    "source": {
        "line": 8,
        "path": "src/testez/src/TestManager.lua"
    }
}