SuaveConfig Module

Functions and values

Function or value Description

firstBinding cfg

Full Usage: firstBinding cfg

Parameters:
Returns: HttpBinding

Finds an endpoint that is configured from the given configuration. Throws an exception if the configuration has no bindings. Useful if you make the suave configuration parametised, because it is then enough for your software to find a valid endpoint to make HTTP/ES/WebSocket requests to.

cfg : SuaveConfig
Returns: HttpBinding

firstBindingUri cfg path query

Full Usage: firstBindingUri cfg path query

Parameters:
Returns: Uri

Construct a `System.Uri` from the first binding available in Suave, by giving a path and a uri.

cfg : SuaveConfig
path : string
query : string
Returns: Uri

toRuntime config contentFolder compressionFolder

Full Usage: toRuntime config contentFolder compressionFolder

Parameters:
    config : SuaveConfig
    contentFolder : string
    compressionFolder : string

Returns: HttpBinding -> HttpRuntime

Convert the Suave configuration to a runtime that the web server understands. You will normally not have to use this function as a consumer from the library, but it may be useful for unit testing with the HttpRuntime record.

config : SuaveConfig
contentFolder : string
compressionFolder : string
Returns: HttpBinding -> HttpRuntime