package bonsai

  1. Overview
  2. Docs
package bonsai
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

t is equivalent to Core_bench_js.Test.t. We don't expose the equality because these benchmarks should only be run using Bonsai_bench.bench so that we can do necessary clean-up between benchmark runs.

val create : ?clock:Bonsai_test.Incr.Clock.t -> name:string -> component:'r Bonsai.Computation.t -> get_inject:('r -> 'a -> unit Bonsai_test.Effect.t) -> 'a Interaction.t -> t

create produces a benchmark which performs interactions on component. The computation is shared between runs within the benchmark runner. Since they are run a non-deterministic amount of times, benchmarks created this way should either have an interaction which is idempotent on the state, or have similar performance when the interaction is repeated many times.

val create_with_resetter : ?clock:Bonsai_test.Incr.Clock.t -> name:string -> component:'r Bonsai.Computation.t -> get_inject:('r -> 'a -> unit Bonsai_test.Effect.t) -> 'a Interaction.t -> t

create_with_resetter is equivalent to calling create, with interactions equal to Interaction.many interactions; Interaction.reset_model; Interaction.stabilize.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct