Module map
A guided index of Suave’s public surface. For every type and member, see the generated API reference.
| Area | Modules / types | Start here |
|---|---|---|
| Core | WebPart, HttpContext, HttpRequest, SuaveConfig | Async & >=> |
| Routing | Filters, Router | Routing, Router |
| Responses | Successful, RequestErrors, ServerErrors, Redirection, Writers | Requests & responses |
| Files | Files, Compression | Files |
| State | Cookie, State, session helpers | Sessions |
| Security | Authentication, RateLimit | Validation, Rate limiting |
| Realtime | WebSocket | WebSockets |
| Packages | Suave.Json, Suave.DotLiquid | DotLiquid, recipes |
Quick signatures
type WebPart = HttpContext -> Async<HttpContext option>
// Filters
GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS : WebPart
path : string -> WebPart
pathScan : PrintfFormat<_,_,_,_,_'t> -> ('t -> WebPart) -> WebPart
// Responses
OK : string -> WebPart
NOT_FOUND : string -> WebPart
setHeader : string -> string -> WebPart
setMimeType : string -> WebPart
// Composition
choose : WebPart list -> WebPart
(>=>) : WebPart -> WebPart -> WebPartBrowse generated docs: /reference/.