Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Routes
SourceTyped 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.
'a t
represents a path parameter of type 'a.
'a router
represents the internal router data type, where each route can potentially return a value of type 'a .
pattern convert label
allows the creation of custom param matchers. This allows creating matchers for custom types so the router can be extended to use types beyond the ones that ship with the library.
The provided label will be used when pretty printing routes, or when converting a route to a human readable string pattern.
Example:
(* This pattern matches any integer *)
let int = pattern int_of_string_opt "<int>"
let bool = pattern bool_of_string_opt "<bool>"
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
Example:
let add = a + b (* int -> int -> int *)
let add' = return add (* (int -> int -> int) t *)
apply add' int (* (int -> int) t *)
s word
returns a path parser that matches word
exactly and then discards the result.
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.
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.
get_route_patterns
returns a list of human readable route patterns that will be matched by a router.
pattern_of_route
convert a route to a human readable string pattern.