package github-jsoo

  1. Overview
  2. Docs

Module Github.Monad

All API requests are bound through this monad which encapsulates an Lwt cooperative thread and includes some state which may be set via API functions.

Sourcetype 'a t

'a t is an Lwt thread sensitive to GitHub API state.

Sourceval return : 'a -> 'a t

return x is the value x wrapped in a state-sensitive Lwt thread.

Sourceval bind : ('a -> 'b t) -> 'a t -> 'b t

bind m f is the eventual value of f applied to the contents of m. Its argument order is designed for currying.

Sourceval map : ('a -> 'b) -> 'a t -> 'b t

map f m is bind m (fun x -> return (f x)). Its argument order is designed for currying.

Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t

m >>= f is {!bind} f m.

Sourceval (>|=) : 'a t -> ('a -> 'b) -> 'b t

m >|= f is {!map} f m.

Sourceval (>>~) : 'a Response.t t -> ('a -> 'b t) -> 'b t

m >>~ f is m >|= {!Response.value} >>= f.

Sourceval catch : (unit -> 'a t) -> (exn -> 'a t) -> 'a t

catch try with is the result of trying try. If try succeeds, its result is returned. If try raises an exception, with is applied to the exception and the result of with is returned.

Sourceval fail : exn -> 'a t

fail exn raises exception exn inside of the monad.

Sourceval run : 'a t -> 'a Lwt.t

run m is the Lwt thread corresponding to the sequence of API actions represented by m. Once a t has been run, any GitHub API state such as associated default security tokens or declared user agent string will not be available in subsequently bound functions.

Sourceval embed : 'a Lwt.t -> 'a t

embed lwt is an Lwt thread lifted into the GitHub API monad. Its monadic state will be inherited from any monadic values bound before it.