Docs: minor error with Routing

[jasiozet]

Hello, I've noticed a small issue here:
https://github.com/pimbrouwers/Falco/blob/master/doc/routing.md

open Falco
open Falco.Routing
open Falco.HostBuilder

webHost [||] {
    endpoints [
        get "/hello/{name:alpha}" (fun ctx ->
            let route = Request.getRoute ctx
            let name = route.GetString "name" "" // <- This Doesn't compile for me
            let message = sprintf "Hello %s" name
            Response.ofPlainText message ctx)
    ]
}

However this is completely fine:

webHost [||] {
    endpoints [
        get "/hello/{name:alpha}" (fun ctx ->
            let route = Request.getRoute ctx
            let name = route.GetString ("name", "") // Change to tupled parameters made here
            let message = sprintf "Hello %s" name
            Response.ofPlainText message ctx)
    ]
}

The route binding example from here: https://www.falcoframework.com/docs/request.html#route-binding
Is completely fine and uses a simplified version, like this:

open Falco

// Assuming a route pattern of /{Name}
let manualRouteHandler : HttpHandler = fun ctx ->
    let r = Request.getRoute ctx
    let name = r.GetString "Name"
    Response.ofPlainText name ctx

let mapRouteHandler : HttpHandler =
    Request.mapRoute (fun r ->
        r.GetString "Name")
        Response.ofPlainText

Which would translate our first example to something like this:

webHost [||] {
    endpoints [
        get "/hello/{name:alpha}" (fun ctx ->
            let route = Request.getRoute ctx
            let name = route.GetString "name"
            let message = sprintf "Hello %s" name
            Response.ofPlainText message ctx)
    ]
}

That would be one of my suggestion the other is using a working tupled example in a more descriptive way:

webHost [||] {
    endpoints [
        get "/hello/{name:alpha}" (fun ctx ->
            let route = Request.getRoute ctx
            let name = route.GetString ("name", "FalcoEnthusiast") // Could be "defaultValue", "fallbackValue"
            let message = sprintf "Hello %s" name
            Response.ofPlainText message ctx)
    ]
}

But my question is will it ever be an empty string here? Maybe the fallback value is never needed in this example?

I would be very happy to make a PR for that, but it is also a trivial change so might be an overkill.
Have a great New Year Pim and everyone! :)

[pimbrouwers]

Thanks for finding this. It's a relic of the old-style API. I have updated the routing.md document.

[jasiozet]

Thank you! :)

[pimbrouwers]

My pleasure Jan!

…

On Mon., Jan. 2, 2023, 12:54 p.m. Jan Zalewski, ***@***.***> wrote: Thank you! :) — Reply to this email directly, view it on GitHub <#101 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABDB57NBYRLWPZXWPAD3XTDWQMI5BANCNFSM6AAAAAATOCRIU4> . You are receiving this because you modified the open/close state.Message ID: ***@***.***>