mozilla

Revision 505467 of base64

  • Revision slug: Mozilla/Add-ons/SDK/High-Level_APIs/base64
  • Revision title: base64
  • Revision id: 505467
  • Created:
  • Creator: wbamberg
  • Is current revision? No
  • Comment
Tags: 

Revision Content

Unstable

This module provides data encoding and decoding using Base64 algorithms.

var base64 = require("sdk/base64");
 
var encodedData = base64.encode("Hello, World");
var decodedData = base64.decode(encodedData);

Globals

Functions

encode(data, charset)

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

Parameters

data : string
The data to encode

charset : string
The charset of the string to encode (optional). The only accepted value is "utf-8". In order to encode and decode Unicode strings, the charset parameter needs to be set:

var base64 = require("sdk/base64");

var encodedData = base64.encode(unicodeString, "utf-8");
Returns

string : The encoded string

decode(data, charset)

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

Parameters

data : string
The encoded data

charset : string
The charset of the string to encode (optional). The only accepted value is "utf-8". In order to encode and decode Unicode strings, the charset parameter needs to be set:

var base64 = require("sdk/base64");

var decodedData = base64.decode(encodedData, "utf-8");
Returns

string : The decoded string

Revision Source

<div class="note">
 <p>Unstable</p>
</div>
<p>This module provides data encoding and decoding using Base64 algorithms.</p>
<pre class="brush: js">
var base64 = require("sdk/base64");
 
var encodedData = base64.encode("Hello, World");
var decodedData = base64.decode(encodedData);</pre>
<h2 id="Globals">Globals</h2>
<h3 id="Functions">Functions</h3>
<h4 class="addon-sdk-api-name" id="encode(data.2C_charset)"><code>encode(data, charset)</code></h4>
<p>Creates a base-64 encoded ASCII string from a string of binary data.</p>
<h5 id="Parameters">Parameters</h5>
<p><strong>data : string</strong><br />
 The data to encode</p>
<p><strong>charset : string</strong><br />
 The charset of the string to encode (optional). The only accepted value is <code>"utf-8"</code>. In order to encode and decode Unicode strings, the charset parameter needs to be set:</p>
<pre class="brush: js">
var base64 = require("sdk/base64");

var encodedData = base64.encode(unicodeString, "utf-8");
</pre>
<h5 id="Returns">Returns</h5>
<p><strong>string</strong> : The encoded string</p>
<h4 class="addon-sdk-api-name" id="decode(data.2C_charset)"><code>decode(data, charset)</code></h4>
<p>Decodes a string of data which has been encoded using base-64 encoding.</p>
<h5 id="Parameters">Parameters</h5>
<p><strong>data : string</strong><br />
 The encoded data</p>
<p><strong>charset : string</strong><br />
 The charset of the string to encode (optional). The only accepted value is <code>"utf-8"</code>. In order to encode and decode Unicode strings, the charset parameter needs to be set:</p>
<pre class="brush: js">
var base64 = require("sdk/base64");

var decodedData = base64.decode(encodedData, "utf-8");</pre>
<h5 id="Returns">Returns</h5>
<p><strong>string</strong> : The decoded string</p>
Revert to this revision