base64

The module provides data encoding and decoding using Base64 algorithms.

Example

?
1
2
3
4
var base64 = require("api-utils/base64");
 
var encodedData = base64.encode("Hello, World");
var decodedData = base64.decode(encodedData);

Unicode Strings

In order to encode and decode properly Unicode strings, the charset parameter needs to be set to "utf-8":

?
1
2
3
4
var base64 = require("api-utils/base64");
 
var encodedData = base64.encode(unicodeString, "utf-8");
var decodedData = base64.decode(encodedData, "utf-8");

API Reference

Functions

encode(data, charset)

Creates a base-64 encoded ASCII string from a string of binary data.

data : string

The data to encode

[ charset : string ]

The charset of the string to encode (optional). The only accepted value is "utf-8".

Returns: string

The encoded string

decode(data, charset)

Decodes a string of data which has been encoded using base-64 encoding.

data : string

The encoded data

[ charset : string ]

The charset of the string to encode (optional). The only accepted value is "utf-8".

Returns: string

The decoded string