47 lines
1.0 KiB
Markdown
47 lines
1.0 KiB
Markdown
# BenchmarkAPI
|
|
Benchmark API methods
|
|
|
|
## Functions
|
|
|
|
|Method|Returns|Description|
|
|
|---|---|---|
|
|
|[API.clear](#API.clear)|-|Removes a benchmark's data
|
|
|[API.clearAll](#API.clearAll)|-|Removes all custom benchmark data
|
|
|[API.getStats](#API.getStats)|table?|Retrieves benchmark statistics
|
|
|[API.start](#API.start)|-|Starts timing a custom operation
|
|
|[API.stop](#API.stop)|-|Stops timing and logs results
|
|
|
|
|
|
## API.clear(name)
|
|
Clears a specific benchmark
|
|
|
|
### Parameters
|
|
* `name` `string` The name of the benchmark to clear
|
|
|
|
## API.clearAll()
|
|
Clears all custom benchmarks
|
|
|
|
## API.getStats(name)
|
|
Gets statistics for a benchmark
|
|
|
|
### Parameters
|
|
* `name` `string` The name of the benchmark
|
|
|
|
### Returns
|
|
* `table?` `stats` The benchmark statistics or nil
|
|
|
|
## API.start(name, options?)
|
|
Starts a custom benchmark
|
|
|
|
### Parameters
|
|
* `name` `string` The name of the benchmark
|
|
* `options` *(optional)* `table` Optional configuration
|
|
|
|
## API.stop(name)
|
|
Stops a custom benchmark
|
|
|
|
### Parameters
|
|
* `name` `string` The name of the benchmark to stop
|
|
|
|
|