Class BubbleBabble


Version 1.0.
Create a new BubbleBabble encoder/decoder class
Defined in: bubblebabble.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
decode(src)
Decode an BubbleBabble string to string
 
encode(src)
Encode an input string to BubbleBabble string
 
isEncoded(src)
Return true if the input string is BubbleBabble encoded
 
transform(src)
Transform an input string to decoded string or BubbleBabble string
Class Detail
BubbleBabble()
Method Detail
{string} decode(src)
Decode an BubbleBabble string to string
new BubbleBabble().decode('xinik-zorox'); // Will return foo
Parameters:
{string} src
BubbleBabble string
Throws:
{exception}
when the BubbleBabble is not correctly encoded
Returns:
{string} A string

{string} encode(src)
Encode an input string to BubbleBabble string
new BubbleBabble().encode('foo'); // Will return xinik-zorox
Parameters:
{string} src
Input string
Returns:
{string} An encoded string

{booblean} isEncoded(src)
Return true if the input string is BubbleBabble encoded
new BubbleBabble().isEncoded('xinik-zorox'); // true
Parameters:
{string} src
input string
Returns:
{booblean} true if the input is BubbleBabble encoded, false else

{string} transform(src)
Transform an input string to decoded string or BubbleBabble string
new BubbleBabble().transform('foo'); // Will return xinik-zorox
new BubbleBabble().transform('xinik-zorox'); // Will return foo
Parameters:
{string} src
Input string
Returns:
{string} An decoded or encoded string

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Nov 22 2013 10:24:59 GMT+0100 (CET)