Deno.BenchDefinition

The interface for defining a benchmark test using Deno.bench.

interface BenchDefinition {
baseline?: boolean;
fn: (b: BenchContext) => void | Promise<void>;
group?: string;
ignore?: boolean;
name: string;
only?: boolean;
permissions?: PermissionOptions;
sanitizeExit?: boolean;
}

§Properties

§
baseline?: boolean
[src]

Benchmark should be used as the baseline for other benchmarks.

If there are multiple baselines in a group, the first one is used as the baseline.

§
fn: (b: BenchContext) => void | Promise<void>
[src]

The test function which will be benchmarked.

§
group?: string
[src]

Group name for the benchmark.

Grouped benchmarks produce a group time summary, where the difference in performance between each test of the group is compared.

§
ignore?: boolean
[src]

If truthy, the benchmark test will be ignored/skipped.

§
name: string
[src]

The name of the test, which will be used in displaying the results.

§
only?: boolean
[src]

If at least one bench has only set to true, only run benches that have only set to true and fail the bench suite.

§

Specifies the permissions that should be used to run the bench.

Set this to "inherit" to keep the calling thread's permissions.

Set this to "none" to revoke all permissions.

§
sanitizeExit?: boolean
[src]

Ensure the bench case does not prematurely cause the process to exit, for example via a call to Deno.exit.