BenchmarkAPI
Benchmark API methods
Functions
| Method | Returns | Description |
|---|---|---|
| API.clear | - | Removes a benchmark's data |
| API.clearAll | - | Removes all custom benchmark data |
| API.getStats | table? | Retrieves benchmark statistics |
| API.start | - | Starts timing a custom operation |
| API.stop | - | Stops timing and logs results |
API.clear(name)
Clears a specific benchmark
Parameters
namestringThe name of the benchmark to clear
API.clearAll()
Clears all custom benchmarks
API.getStats(name)
Gets statistics for a benchmark
Parameters
namestringThe name of the benchmark
Returns
table?statsThe benchmark statistics or nil
API.start(name, options?)
Starts a custom benchmark
Parameters
namestringThe name of the benchmarkoptions(optional)tableOptional configuration
API.stop(name)
Stops a custom benchmark
Parameters
namestringThe name of the benchmark to stop