Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Doc: adding some example in Lwt_js_events ocamldoc
  • Loading branch information
Vincent Balat committed Nov 28, 2014
1 parent 23b756d commit d8e03be
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions lib/lwt_js_events.mli
Expand Up @@ -29,6 +29,38 @@
*)

(**
Examples of use:
Waiting for a click on [elt1] before continuing:
{[lwt _ = Lwt_js_events.click elt1 in]}
Doing some operation for each value change in input element [inp]:
{[Lwt_js_events.(async (fun () ->
clicks inp1 (fun ev _ -> ...)
))]}
Defining a thread that waits for ESC key on an element:
{[let rec esc elt =
lwt ev = keydown elt in
if ev##keyCode = 27
then Lwt.return ev
else esc elt]}
Waiting for a click or escape key before continuing:
{[lwt () =
Lwt.pick [(lwt _ = esc Dom_html.document in Lwt.return ());
(lwt _ = click Dom_html.document in Lwt.return ())]
in ...]}
*)



(** {2 Create Lwt threads for events} *)
Expand Down

0 comments on commit d8e03be

Please sign in to comment.