package lwt_react

with_finaliser f e returns an event e' which behave as e, except that f is called when e' is garbage collected.

next e returns the next occurrence of e.

Avoid trying to create an “asynchronous loop” by calling next e again in a callback attached to the promise returned by next e:

• The callback is called within the React update step, so calling next e within it will return a promise that is fulfilled with the same value as the current occurrence.
• If you instead arrange for the React update step to end (for example, by calling Lwt.pause () within the callback), multiple React update steps may occur before the callback calls next e again, so some occurrences can be effectively “lost.”

To robustly asynchronously process occurrences of e in a loop, use to_stream e, and repeatedly call Lwt_stream.next on the resulting stream.

limit f e limits the rate of e with f.

For example, to limit the rate of an event to 1 per second you can use: limit (fun () -> Lwt_unix.sleep 1.0) event.

from f creates an event which occurs each time f () returns a value. If f raises an exception, the event is just stopped.

Creates a stream holding all values occurring on the given event

of_stream stream creates an event which occurs each time a value is available on the stream.

If updating the event causes an exception at any point during the update step, the exception is passed to !Lwt.async_exception_hook, which terminates the process by default.

delay promise is an event which does not occur until promise resolves. Then it behaves as the event returned by promise.

keep e keeps a reference to e so it will never be garbage collected.