Differences

This shows you the differences between two versions of the page.

--- syntax:functions:encode [2019/10/30 19:38] – dmitry
+++ syntax:functions:encode [2021/09/17 22:19] – craigt
@@ Line 1: / Line 1: @@
-=====encode(method, text)=====
+====== Encode(method, text) ======
+Category:  Web function
+\\
+=====Description=====
+This function encodes a text string using one of the available methods below.
-Encodes a text string using one of the available methods below:
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|method  | Text |The encoding method to use on //text//.  See the table below.  |
+|text  |Text |The text string to be encoded.  |
+**Return value type:** Text.
-^  Method  ^  Notes  ^
+\\
+^Method  ^Notes  ^
 |uriComponentEscape |Escapes a URI, and then converts any spaces into plus characters ("+"). |
 |Base64 |
 |Base64url | Base64 in URL encoding |
-**Example**
+\\
-^  Expression ^  Result  ^
+=====Examples=====
-| encode("uriComponentEscape", "one+one")   |one%2Bone |
+  encode("uriComponentEscape", "one+one")  //Returns 'one%2Bone'
-**See also**
+\\
+=====See also=====
+  * [[syntax:functions:decode|Decode(method, text)]]
+  * [[syntax:functions:uriencode|URIEncode(encoding, value)]]
-  * [[syntax:functions:decode]]
-  * [[syntax:functions:uriencode]]