Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Typed routing for OCaml. Routes
provides combinators for adding typed routing to OCaml applications. The core library will be independent of any particular web framework or runtime.
module Method : sig ... end
'a router
represents the internal router data type, where each route can potentially return a value of type 'a .
val return : 'a -> 'a t
return v
is a path param parser that always returns v.
apply f t
applies a function f that is wrapped inside a 'a t
context to a path param parser. f <*> p is the same as f >>= fun f -> map ~f p
val s : string -> unit t
s word
returns a path parser that matches word
exactly and then discards the result.
val int : int t
int
parses a path parmeter and succeeds if its an integer.
val int32 : int32 t
int32
parses a path parameter and succeeds if its a valid 32 bit integer.
val int64 : int64 t
int64
parses a path parameter and succeeds if its a valid 64 bit integer.
val bool : bool t
bool
parses a path parameter and succeeds if its either "true" or "false".
val str : string t
str
parses a path param and returns it as a string.
val empty : unit t
empty
matches an empty target. This can be used to match against "/".
one_of
accepts a list of route parsers and converts into a router. ignore_trailing_slash is a boolean flag that can control whether to keep or ignore the trailing slash in the input target url. The default value is true.
with_method
accepts a list of routes + http methods and converts it into a router. This will also group methods based on the Http verb. If there are multiple route definitions that overlap and are potential matches, the one defined first will be returned.
ignore_trailing_slash is a boolean flag that can control whether to keep or ignore the trailing slash in the input target url. The default value is true.
val match' : 'a router -> string -> 'a option
match'
runs the router against the provided target url.
match_with_method
is used to run the router. It accepts a target url string, HTTP method verb a request of any type (which is forwarded as the last parameter to the handler functions). If a route matches it runs the attached handler and returns the result.
module Infix : sig ... end
module Routes_private : sig ... end