package bonsai

You can search for identifiers within the package.

in-package search v0.2.0

package bonsai

bonsai
- Bonsai
  - Make
    
    Applicative_infix
    
    Either
    
    Event
    
    Expert
    
    Snapshot
    
    Incr
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
    
    Incremental
    
    Case
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Open_on_rhs_intf
    
    Option
    
    Project
    
    Model
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
  - S
    
    Applicative_infix
    
    Either
    
    Event
    
    Expert
    
    Snapshot
    
    Incr
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
    
    Incremental
    
    Case
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Open_on_rhs_intf
    
    Option
    
    Project
    
    Model
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
bonsai.web
- Bonsai_web
  - Bonsai
    
    Applicative_infix
    
    Either
    
    Expert
    
    Snapshot
    
    Incremental
    
    Case
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Open_on_rhs_intf
    
    Option
    
    Project
    
    Model
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
  - Start
    
    Handle

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Input : Core_kernel.T

module Model : Core_kernel.T

module Action : sig ... end

module Result : Core_kernel.T

val apply_action : 
  inject:(Action.t -> Event.t) ->
  schedule_event:(Event.t -> unit) ->
  Input.t ->
  Model.t ->
  Action.t ->
  Model.t

apply_action is a transformation from a model and an action into a new model. During the transformation, the Component can also emit more actions via schedule_event or use Async to arrange for schedule_event to be called later.

val compute : inject:(Action.t -> Event.t) -> Input.t -> Model.t -> Result.t

Computes the Result.t of the component based off of the Model.t.

The inject argument is used to transform actions into Event.ts for use in event handlers like on_click.

val name : string

A name to identify this component.

A reasonable fallback is Source_code_position.to_string [%here].