docs-v2/content/flux/v0/stdlib/http/pathescape.md

3.5 KiB

title description menu weight introduced
http.pathEscape() function `http.pathEscape()` escapes special characters in a string (including `/`) and replaces non-ASCII characters with hexadecimal representations (`%XX`).
flux_v0_ref
name parent identifier
http.pathEscape http http/pathEscape
101 0.71.0

http.pathEscape() escapes special characters in a string (including /) and replaces non-ASCII characters with hexadecimal representations (%XX).

Function type signature
(inputString: string) => string

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

inputString

({{< req >}}) String to escape.

Examples

URL-encode a string

import "http"

http.pathEscape(inputString: "Hello world!")// Returns "Hello%20world%21"


URL-encode strings in a stream of tables

import "http"
import "sampledata"

sampledata.string()
    |> map(fn: (r) => ({r with _value: http.pathEscape(inputString: r._value)}))

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time *tag _value
2021-01-01T00:00:00Z t1 smpl_g9qczs
2021-01-01T00:00:10Z t1 smpl_0mgv9n
2021-01-01T00:00:20Z t1 smpl_phw664
2021-01-01T00:00:30Z t1 smpl_guvzy4
2021-01-01T00:00:40Z t1 smpl_5v3cce
2021-01-01T00:00:50Z t1 smpl_s9fmgy
_time *tag _value
2021-01-01T00:00:00Z t2 smpl_b5eida
2021-01-01T00:00:10Z t2 smpl_eu4oxp
2021-01-01T00:00:20Z t2 smpl_5g7tz4
2021-01-01T00:00:30Z t2 smpl_sox1ut
2021-01-01T00:00:40Z t2 smpl_wfm757
2021-01-01T00:00:50Z t2 smpl_dtn2bv

Output data

_time _value *tag
2021-01-01T00:00:00Z smpl_g9qczs t1
2021-01-01T00:00:10Z smpl_0mgv9n t1
2021-01-01T00:00:20Z smpl_phw664 t1
2021-01-01T00:00:30Z smpl_guvzy4 t1
2021-01-01T00:00:40Z smpl_5v3cce t1
2021-01-01T00:00:50Z smpl_s9fmgy t1
_time _value *tag
2021-01-01T00:00:00Z smpl_b5eida t2
2021-01-01T00:00:10Z smpl_eu4oxp t2
2021-01-01T00:00:20Z smpl_5g7tz4 t2
2021-01-01T00:00:30Z smpl_sox1ut t2
2021-01-01T00:00:40Z smpl_wfm757 t2
2021-01-01T00:00:50Z smpl_dtn2bv t2

{{% /expand %}} {{< /expand-wrapper >}}