Javascript Engine
Line 1: | Line 1: | ||
+ | * atob | ||
+ | Decode Base64 data.<br> | ||
+ | Parameters:<br> | ||
+ | '''b64_str''': Mandatory, Base64 encoded data<br> | ||
+ | Return:<br> | ||
+ | Decoded data, boolean ''false'' on failure (invalid Base64 data) | ||
+ | str = Engine.atob(b64_str) | ||
+ | |||
+ | * btoa | ||
+ | Encode string data to Base64.<br> | ||
+ | Parameters:<br> | ||
+ | '''str''': Mandatory, data to encode<br> | ||
+ | '''line_len''': Optional line length (split encoded data, add end of line after each '''line_len''' chars)<br> | ||
+ | '''add_eol''': Optional, add an extra end of line after encoded data<br> | ||
+ | Return:<br> | ||
+ | Base64 encoded data | ||
+ | b64_str = Engine.btoa(str[,line_len[,add_eol]]) | ||
+ | |||
* atoh | * atoh | ||
+ | Decode Base64 data.<br> | ||
+ | Parameters:<br> | ||
+ | '''b64_str''': Mandatory, Base64 encoded data<br> | ||
+ | '''hex_sep''': Optional separator to use between octets. Set it to 'undefined' if not used and '''hex_upcase''' is given<br> | ||
+ | '''hex_upcase''': Optional, use upper case characters in hexa<br> | ||
+ | Return:<br> | ||
+ | Hexified string, boolean ''false'' on failure (invalid Base64 data) | ||
hex_str = Engine.atoh(b64_str[,hex_sep[,hex_upcase]]) | hex_str = Engine.atoh(b64_str[,hex_sep[,hex_upcase]]) | ||
− | * | + | * htoa |
− | b64_str = Engine. | + | Encode hexified binary (string) data to Base64.<br> |
+ | Parameters:<br> | ||
+ | '''hex_str''': Mandatory, data to encode<br> | ||
+ | '''line_len''': Optional line length (split encoded data, add end of line after each '''line_len''' chars)<br> | ||
+ | '''add_eol''': Optional, add an extra end of line after encoded data<br> | ||
+ | Return:<br> | ||
+ | The string, boolean ''false'' on failure (invalid input string). | ||
+ | b64_str = Engine.htob(hex_str[,line_len[,add_eol]]) | ||
+ | |||
+ | * btoh | ||
+ | Convert binary (string) data to hexified string.<br> | ||
+ | Parameters:<br> | ||
+ | '''str''': Mandatory, data to hexify<br> | ||
+ | '''hex_sep''': Optional separator to use between octets. Set it to 'undefined' if not used and '''hex_upcase''' is given<br> | ||
+ | '''hex_upcase''': Optional, use upper case characters in hexa<br> | ||
+ | Return:<br> | ||
+ | Hexified string | ||
+ | hex_str = Engine.btoh(str[,hex_sep[,hex_upcase]]) | ||
+ | |||
+ | * htob | ||
+ | Unhexify binary (string) data.<br> | ||
+ | Parameters:<br> | ||
+ | '''hex_str''': Mandatory, data to unhexify<br> | ||
+ | '''hex_sep''': Optional separator between octets. Set it to 'undefined' if missing or unknown (autodetect)<br> | ||
+ | Return:<br> | ||
+ | The string, boolean ''false'' on failure (invalid input string). | ||
+ | str = Engine.htob(hex_str[,hex_sep]) |
Revision as of 10:32, 7 July 2014
- atob
Decode Base64 data.
Parameters:
b64_str: Mandatory, Base64 encoded data
Return:
Decoded data, boolean false on failure (invalid Base64 data)
str = Engine.atob(b64_str)
- btoa
Encode string data to Base64.
Parameters:
str: Mandatory, data to encode
line_len: Optional line length (split encoded data, add end of line after each line_len chars)
add_eol: Optional, add an extra end of line after encoded data
Return:
Base64 encoded data
b64_str = Engine.btoa(str[,line_len[,add_eol]])
- atoh
Decode Base64 data.
Parameters:
b64_str: Mandatory, Base64 encoded data
hex_sep: Optional separator to use between octets. Set it to 'undefined' if not used and hex_upcase is given
hex_upcase: Optional, use upper case characters in hexa
Return:
Hexified string, boolean false on failure (invalid Base64 data)
hex_str = Engine.atoh(b64_str[,hex_sep[,hex_upcase]])
- htoa
Encode hexified binary (string) data to Base64.
Parameters:
hex_str: Mandatory, data to encode
line_len: Optional line length (split encoded data, add end of line after each line_len chars)
add_eol: Optional, add an extra end of line after encoded data
Return:
The string, boolean false on failure (invalid input string).
b64_str = Engine.htob(hex_str[,line_len[,add_eol]])
- btoh
Convert binary (string) data to hexified string.
Parameters:
str: Mandatory, data to hexify
hex_sep: Optional separator to use between octets. Set it to 'undefined' if not used and hex_upcase is given
hex_upcase: Optional, use upper case characters in hexa
Return:
Hexified string
hex_str = Engine.btoh(str[,hex_sep[,hex_upcase]])
- htob
Unhexify binary (string) data.
Parameters:
hex_str: Mandatory, data to unhexify
hex_sep: Optional separator between octets. Set it to 'undefined' if missing or unknown (autodetect)
Return:
The string, boolean false on failure (invalid input string).
str = Engine.htob(hex_str[,hex_sep])