BenchDefinition class

The interface for defining a benchmark test using {@linkcode Deno.bench}.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

BenchDefinition({FutureOr<void> fn(BenchContext)?, String? name, bool? ignore, String? group, bool? baseline, bool? only, bool? sanitizeExit, Object? permissions})
factory

Properties

baseline ↔ bool?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

Benchmark should be used as the baseline for other benchmarks.
getter/setter pair
fn ↔ FutureOr<void> Function(BenchContext)

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

The test function which will be benchmarked.
getter/setter pair
group ↔ String?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

Group name for the benchmark.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
ignore ↔ bool?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

If truthy, the benchmark test will be ignored/skipped.
getter/setter pair
name ↔ String

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

The name of the test, which will be used in displaying the results.
getter/setter pair
only ↔ bool?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

If at least one bench has only set to true, only run benches that have only set to true and fail the bench suite.
getter/setter pair
permissions ↔ Object?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

Specifies the permissions that should be used to run the bench.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sanitizeExit ↔ bool?

Available on BenchDefinition, provided by the BenchDefinition$Typings extension

Ensure the bench case does not prematurely cause the process to exit, for example via a call to {@linkcode Deno.exit}.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited