Reference · Web

url_encode

url_encode(any) -> str

What it does

The value's text written for a URL: every byte but letters, digits and -_.~ becomes %XX. A map gives a query string, a=1&b=x%20y, each key and value encoded, leaving out keys whose value is null. It is encodeURIComponent, except that !'()* are encoded too; the browser's url_encode gives the same.

Examples

print(url_encode("a b"))print(url_encode("a&b=c/d?e#f"))print(url_encode({ q: "a b", page: 2 }))print(`/search?${url_encode({ q: "tea & cake" })}`)

a%20ba%26b%3Dc%2Fd%3Fe%23fq=a%20b&page=2/search?q=tea%20%26%20cake

Edge cases

• A space is %20, not +; a + in the text is %2B.
• Text outside ASCII is encoded byte by byte as UTF-8.
• !'()* are encoded, unlike in JavaScript; -_.~ are kept.
• In a map, a null value drops its key; false and "" stay. Keys are encoded too. An empty map gives the empty string. The keys go in the order they were set, in the browser too, keys that look like numbers included ({ b: 1, "1": 2 } is b=1&1=2).
• A list or a map inside a map is its printed form, encoded; null on its own gives null.

print(url_encode("a+b c"), url_encode("héllo"))print(url_encode("!'()*"), url_encode("-_.~"))print(url_encode({ q: "x", skip: null, n: 0, t: false, e: "" }))print(url_encode({ "a b": "c&d" }), url_encode({}) == "")print(url_encode([1, 2]), url_encode(null))

a%2Bb%20c h%C3%A9llo%21%27%28%29%2A -_.~q=x&n=0&t=false&e=a%20b=c%26d true%5B1%2C%202%5D null

Errors

url_encode never fails: a number, a boolean or a decimal is its text. An error value given, or one among a map's values, is given back rather than put in the URL as its text.

print(url_encode(42), url_encode(dec("1.50")), url_encode(true))print(url_encode(err("no page")), url_encode({ q: "x", page: int("two") }))

42 1.50 trueerr("no page") err("not an int: \"two\"")

Chaining

print("next page" | url_encode)let next = "/items?page=2" | url_encodeprint(`/login?next=${next}`)

next%20page/login?next=%2Fitems%3Fpage%3D2

fn signed_in(r) = session().user != null ? r : reply 303 redirect(`/login?next=${url_encode(r.path)}`)

See also

escape, redirect, str

Edit this page on GitHub · every example's output was made by running it (tools/refcheck.mjs) · questions on Discord or r/quillo