From 008bdeb906aa6de85bea8fbcc5352d611ec78076 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Wed, 20 May 2015 02:53:52 -0600 Subject: [PATCH] update docs --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ef475f1..46bacd1 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,40 @@ Base64, TypedArrays, and UTF-8 / Unicode conversions in Browser (and Node) JavaS This is based wholly on the work by good folks at the MDN. See +API +=== + +```javascript +// TypedArray <--> UTF8 +var uint8Array = Unibabel.strToUtf8Arr(str); +var str = Unibabel.utf8ArrToStr(uint8Array); + +// TypedArray <--> Base64 +var base64 = Unibabel.arrToBase64(uint8Array) +var uint8Array = Unibabel.base64ToArr(base64) +``` + Examples ======== ```javascript // Base64 -var myArray = base64DecToArr("QmFzZSA2NCDigJQgTW96aWxsYSBEZXZlbG9wZXIgTmV0d29yaw=="); // "Base 64 \u2014 Mozilla Developer Network" - -var myBuffer = base64DecToArr("QmFzZSA2NCDigJQgTW96aWxsYSBEZXZlbG9wZXIgTmV0d29yaw==").buffer; // "Base 64 \u2014 Mozilla Developer Network" +var myArray = Unibabel.base64ToArr("QmFzZSA2NCDigJQgTW96aWxsYSBEZXZlbG9wZXIgTmV0d29yaw=="); // "Base 64 \u2014 Mozilla Developer Network" +var myBuffer = Unibabel.base64ToArr("QmFzZSA2NCDigJQgTW96aWxsYSBEZXZlbG9wZXIgTmV0d29yaw==").buffer; // "Base 64 \u2014 Mozilla Developer Network" console.log(myBuffer.byteLength); // Crazy Unicode var sMyInput = "I'm a ☢ ☃ that plays 𝄢 guitar and spea̧͈͖ks Ar̽̾̈́͒͑ ̶̧̨̱̹̭̯ͧ̾ͬC̷̙̲̝͖ͭ̏ͥͮ͟Oͮ͏̮̪̝͍M̲̖͊̒ͪͩͬ̚̚͜!"; - -var aMyUTF8Input = strToUTF8Arr(sMyInput); - -var sMyBase64 = base64EncArr(aMyUTF8Input); +var aMyUTF8Input = Unibabel.strToUtf8Arr(sMyInput); +var sMyBase64 = Unibabel.arrToBase64(aMyUTF8Input); alert(sMyBase64); -var aMyUTF8Output = base64DecToArr(sMyBase64); - -var sMyOutput = UTF8ArrToStr(aMyUTF8Output); +var aMyUTF8Output = Unibabel.base64ToArr(sMyBase64); +var sMyOutput = Unibabel.utf8ArrToStr(aMyUTF8Output); alert(sMyOutput); ```