Deno.BenchDefinition

UNSTABLE: New API, yet to be vetted.

interface BenchDefinition {
baseline?: boolean;
fn: () => void | Promise<void>;
group?: string;
ignore?: boolean;
name: string;
only?: boolean;
permissions?: Deno.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: () => void | Promise<void>
[src]
§
group?: string
[src]

Group name for the benchmark. Grouped benchmarks produce a time summary

§
ignore?: boolean
[src]
§
name: string
[src]
§
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.

Defaults to "inherit".

§
sanitizeExit?: boolean
[src]

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