racket/collects/web-server/scribblings/url-param.scrbl

32 lines
1001 B
Racket

#lang scribble/doc
@(require "web-server.rkt")
@title[#:tag "url-param"]{URL Param}
@(require (for-label web-server/private/url-param
net/url))
@defmodule[web-server/private/url-param]{
The @web-server needs to encode information in URLs. If this data
is stored in the query string, than it will be overridden by browsers that
make GET requests to those URLs with more query data. So, it must be encoded
in URL params. This module provides functions for helping
with this process.
@defproc[(insert-param [u url?]
[k string?]
[v string?])
url?]{
Associates @racket[k] with @racket[v] in the final URL param of @racket[u],
overwritting any current binding for @racket[k].
}
@defproc[(extract-param [u url?]
[k string?])
(or/c string? false/c)]{
Extracts the string associated with @racket[k] in the final URL param of
@racket[u], if there is one, returning @racket[#f] otherwise.
}
}