mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-25 01:00:16 -05:00
migrate docs to mdx
This commit is contained in:
32
website/docs/language/functions/urlencode.mdx
Normal file
32
website/docs/language/functions/urlencode.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
page_title: urlencode - Functions - Configuration Language
|
||||
description: The urlencode function applies URL encoding to a given string.
|
||||
sidebar_title: urlencode
|
||||
---
|
||||
|
||||
# `urlencode` Function
|
||||
|
||||
`urlencode` applies URL encoding to a given string.
|
||||
|
||||
This function identifies characters in the given string that would have a
|
||||
special meaning when included as a query string argument in a URL and
|
||||
escapes them using
|
||||
[RFC 3986 "percent encoding"](https://tools.ietf.org/html/rfc3986#section-2.1).
|
||||
|
||||
The exact set of characters escaped may change over time, but the result
|
||||
is guaranteed to be interpolatable into a query string argument without
|
||||
inadvertently introducing additional delimiters.
|
||||
|
||||
If the given string contains non-ASCII characters, these are first encoded as
|
||||
UTF-8 and then percent encoding is applied separately to each UTF-8 byte.
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
> urlencode("Hello World")
|
||||
Hello%20World
|
||||
> urlencode("☃")
|
||||
%E2%98%83
|
||||
> "http://example.com/search?q=${urlencode("terraform urlencode")}"
|
||||
http://example.com/search?q=terraform+urlencode
|
||||
```
|
||||
Reference in New Issue
Block a user