12 |
17 | OCaml package documentation
13 |-
14 |
- naboris 0.1.1 15 |
Naboris__QueryNaboris__.QueryNaboris.QueryMap type for working with queries from routed requests.
Naboris__MimeTypesNaboris__RequestHandlertype 'sessionData t = Naboris.Route.t -> 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.t Lwt.tNaboris__.MimeTypesNaboris.RequestHandlerModule defining RequestHandler functions.
Naboris__ErrorHandlertype t = exn -> Naboris.Route.t -> ((string * string) list * string) Lwt.tCalled when Res.reportError is called. Expects return values of an Lwt.t promise containing a tuple of headers (list(string * string)) and response_body (string).
Naboris__.RequestHandlertype 'sessionData t = Naboris.Route.t -> 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.t Lwt.tNaboris.MimeTypesLess commonly used.
Naboris__.ErrorHandlertype t = exn -> Naboris.Route.t -> ((string * string) list * string) Lwt.tCalled when Res.reportError is called. Expects return values of an Lwt.t promise containing a tuple of headers (list(string * string)) and response_body (string).
Naboris.ErrorHandlerModule with error handler types.
type t = exn -> Route.t -> ((string * string) list * string) Lwt.tCalled when Res.reportError is called. Expects return values of an Lwt.t promise containing a tuple of headers (list(string * string)) and response_body (string).
Naboris__Middlewaretype 'sessionData t = 'sessionData Naboris.RequestHandler.t -> Naboris.Route.t -> 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.t Lwt.t27 | Thanks for signing up for the Naboris newsletter. 28 | This will help you keep up to date with new features and releases. 29 |
30 |Naboris.MiddlewareModule defining middleware functions.
type 'sessionData t = 'sessionData RequestHandler.t -> Route.t -> 'sessionData Req.t -> Res.t -> Res.t Lwt.tNaboris__Cookieval getSessionId : string -> string -> string optionGiven the session id key and cookie header string values extracts sessonId
val sessionIdOfReq : 'sessionData Naboris.Req.t -> string optionExtract sessionId from http cookie headers in Req.t
Naboris__.Cookieval getSessionId : string -> string -> string optionGiven the session id key and cookie header string values extracts sessonId
val sessionIdOfReq : 'sessionData Naboris.Req.t -> string optionExtract sessionId from http cookie headers in Req.t
Naboris__.Middlewaretype 'sessionData t = 'sessionData Naboris.RequestHandler.t -> Naboris.Route.t -> 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.t Lwt.tNaboris.CookieLess commonly used.
val getSessionId : string -> string -> string optionGiven the session id key and cookie header string values extracts sessonId
val sessionIdOfReq : 'sessionData Req.t -> string optionExtract sessionId from http cookie headers in Req.t
More better documentation is in the works and coming soon. For now please review the ocaml typespec below.
31 | odocs 32 |Naboris__Sessionval create : string -> 'sessionData -> 'sessionData tCreates new t('sessionData) with id of string.
val data : 'sessionData t -> 'sessionDataReturn session data of given t('sessionData).
val id : 'sessionData t -> stringReturn session id of given t('sessionData).
Naboris__.Sessionval create : string -> 'sessionData -> 'sessionData tCreates new t('sessionData) with id of string.
val data : 'sessionData t -> 'sessionDataReturn session data of given t('sessionData).
val id : 'sessionData t -> stringReturn session id of given t('sessionData).
Naboris__Routerval generateRoute : string -> Naboris.Method.t -> Naboris.Route.tGenerate a route record from a uri target and http method.
val processPath : string -> string list * string * string list Naboris__.Query.QueryMap.tExtracts useful parts from a uri string.
Naboris.SessionModule for working with sessions and session data.
val create : string -> 'sessionData -> 'sessionData tCreates new t('sessionData) with id of string.
val data : 'sessionData t -> 'sessionDataReturn session data of given t('sessionData).
val id : 'sessionData t -> stringReturn session id of given t('sessionData).
Naboris__.Routerval generateRoute : string -> Naboris.Method.t -> Naboris.Route.tGenerate a route record from a uri target and http method.
val processPath : string -> string list * string * string list Naboris__.Query.QueryMap.tExtracts useful parts from a uri string.
Naboris.RouterLess commonly used.
val generateRoute : string -> Method.t -> Route.tGenerate a route record from a uri target and http method.
val processPath : string -> string list * string * string list Naboris__.Query.QueryMap.tExtracts useful parts from a uri string.
Naboris__SessionConfigtype 'sessionData t = {getSession : string option -> 'sessionData Naboris.Session.t option Lwt.t; |
sidKey : string; |
maxAge : int; |
}val sidKey : 'sessionData t option -> stringReturns key to be used for session cookies.
val maxAge : 'sessionData t option -> intReturns max age to be used for session cookies.
Naboris__.SessionConfigtype 'sessionData t = {getSession : string option -> 'sessionData Naboris.Session.t option Lwt.t; |
sidKey : string; |
maxAge : int; |
}val sidKey : 'sessionData t option -> stringReturns key to be used for session cookies.
val maxAge : 'sessionData t option -> intReturns max age to be used for session cookies.
Naboris.SessionConfigLess commonly used.
type 'sessionData t = {getSession : string option -> 'sessionData Session.t option Lwt.t; |
sidKey : string; |
maxAge : int; |
}val sidKey : 'sessionData t option -> stringReturns key to be used for session cookies.
val maxAge : 'sessionData t option -> intReturns max age to be used for session cookies.
Naboris__Servermodule Req = Naboris.Reqmodule Res = Naboris.Resmodule Router = Naboris.Routerval buildConnectionHandler : 'a Naboris.ServerConfig.t -> Unix.sockaddr -> Lwt_unix.file_descr -> unit Lwt.t27 | Get something up and running! 28 |
29 |Naboris__.Servermodule Req = Naboris.Reqmodule Res = Naboris.Resmodule Router = Naboris.Routerval buildConnectionHandler : 'a Naboris.ServerConfig.t -> Unix.sockaddr -> Lwt_unix.file_descr -> unit Lwt.tNaboris__Routeval path : t -> string listGet path (list(string)) of t.
val meth : t -> Naboris.Method.tGet http method (Method.t) of t.
val rawQuery : t -> stringGet query sring of t.
val query : t -> string list Naboris__.Query.QueryMap.tGet query map Query.QueryMap.t(list(string)) ot t.
val create : string list -> Naboris.Method.t -> string -> string list Naboris__.Query.QueryMap.t -> tIntended for internal use.
Create route record t.
27 | Short and helpful reads. 28 |
29 |Naboris__.Routeval path : t -> string listGet path (list(string)) of t.
val meth : t -> Naboris.Method.tGet http method (Method.t) of t.
val rawQuery : t -> stringGet query sring of t.
val query : t -> string list Naboris__.Query.QueryMap.tGet query map Query.QueryMap.t(list(string)) ot t.
val create : string list -> Naboris.Method.t -> string -> string list Naboris__.Query.QueryMap.t -> tIntended for internal use.
Create route record t.
Naboris.RouteModule to extract routing data.
val path : t -> string listGet path (list(string)) of t.
val rawQuery : t -> stringGet query sring of t.
val query : t -> string list Naboris__.Query.QueryMap.tGet query map Query.QueryMap.t(list(string)) ot t.
val create : string list -> Method.t -> string -> string list Naboris__.Query.QueryMap.t -> tIntended for internal use.
Create route record t.
Naboris.SessionManagerLess commonly used.
val startSession : 'sessionData Req.t -> Res.t -> 'sessionData -> 'sessionData Req.t * Res.t * stringCreate a new session with 'sessionData and add cookie headers to Res.t. Returns newly created session id string.
val removeSession : 'sessionData Req.t -> Res.t -> Res.tSets headers on `Res.t` to expire the session.
val resumeSession : 'sessionData ServerConfig.t -> 'sessionData Req.t -> 'sessionData Req.t Lwt.tIntended for internal use.
Applies mapSession from config to request which uses the session id from the request cookies. Returns promise of a new request with session data available if it was found.
Naboris__SessionManagerval startSession : 'sessionData Naboris.Req.t -> Naboris.Res.t -> 'sessionData -> 'sessionData Naboris.Req.t * Naboris.Res.t * stringCreate a new session with 'sessionData and add cookie headers to Res.t. Returns newly created session id string.
val removeSession : 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.tSets headers on `Res.t` to expire the session.
val resumeSession : 'sessionData Naboris.ServerConfig.t -> 'sessionData Naboris.Req.t -> 'sessionData Naboris.Req.t Lwt.tIntended for internal use.
Applies mapSession from config to request which uses the session id from the request cookies. Returns promise of a new request with session data available if it was found.
Naboris__.SessionManagerval startSession : 'sessionData Naboris.Req.t -> Naboris.Res.t -> 'sessionData -> 'sessionData Naboris.Req.t * Naboris.Res.t * stringCreate a new session with 'sessionData and add cookie headers to Res.t. Returns newly created session id string.
val removeSession : 'sessionData Naboris.Req.t -> Naboris.Res.t -> Naboris.Res.tSets headers on `Res.t` to expire the session.
val resumeSession : 'sessionData Naboris.ServerConfig.t -> 'sessionData Naboris.Req.t -> 'sessionData Naboris.Req.t Lwt.tIntended for internal use.
Applies mapSession from config to request which uses the session id from the request cookies. Returns promise of a new request with session data available if it was found.
Naboris__Method