punycode: Update to v1.0.0

nodejs · Feb 27, 2012 · cacd651 · cacd651
1 parent 50cfeef
commit cacd651
Showing 1 changed file with 16 additions and 16 deletions.
diff --git a/lib/punycode.js b/lib/punycode.js
@@ -1,9 +1,4 @@
-/*!
- * Punycode.js <http://mths.be/punycode>
- * Copyright 2011 Mathias Bynens <http://mathiasbynens.be/>
- * Available under MIT license <http://mths.be/mit>
- */
-
+/*! http://mths.be/punycode by @mathias */
 ;(function(root) {
 
 	/**
@@ -34,7 +29,7 @@
 	delimiter = '-', // '\x2D'
 
 	/** Regular expressions */
-	regexNonASCII = /[^ -~]/, // matches unprintable ASCII chars + non-ASCII chars
+	regexNonASCII = /[^ -~]/, // unprintable ASCII chars + non-ASCII chars
 	regexPunycode = /^xn--/,
 
 	/** Error messages */
@@ -97,13 +92,17 @@
 	}
 
 	/**
-	 * Creates an array containing the decimal code points of each character in
-	 * the string.
+	 * Creates an array containing the decimal code points of each Unicode
+	 * character in the string. While JavaScript uses UCS-2 internally,
+	 * this function will convert a pair of surrogate halves (each of which
+	 * UCS-2 exposes as separate characters) into a single code point,
+	 * matching UTF-16.
 	 * @see `punycode.ucs2.encode`
+	 * @see <http://mathiasbynens.be/notes/javascript-encoding>
 	 * @memberOf punycode.ucs2
 	 * @name decode
-	 * @param {String} string The Unicode input string.
-	 * @returns {Array} The new array.
+	 * @param {String} string The Unicode input string (UCS-2).
+	 * @returns {Array} The new array of code points.
 	 */
 	function ucs2decode(string) {
 		var output = [],
@@ -131,7 +130,7 @@
 	 * @memberOf punycode.ucs2
 	 * @name encode
 	 * @param {Array} codePoints The array of decimal code points.
-	 * @returns {String} The new string.
+	 * @returns {String} The new Unicode string (UCS-2).
 	 */
 	function ucs2encode(array) {
 		return map(array, function(value) {
@@ -281,7 +280,7 @@
 				}
 
 				i += digit * w;
-				t = k <= bias ? tMin : k >= bias + tMax ? tMax : k - bias;
+				t = k <= bias ? tMin : (k >= bias + tMax ? tMax : k - bias);
 
 				if (digit < t) {
 					break;
@@ -404,7 +403,7 @@
 				if (currentValue == n) {
 					// Represent delta as a generalized variable-length integer
 					for (q = delta, k = base; /* no condition */; k += base) {
-						t = k <= bias ? tMin : k >= bias + tMax ? tMax : k - bias;
+						t = k <= bias ? tMin : (k >= bias + tMax ? tMax : k - bias);
 						if (q < t) {
 							break;
 						}
@@ -473,10 +472,11 @@
 		 * @memberOf punycode
 		 * @type String
 		 */
-		'version': '0.3.0',
+		'version': '1.0.0',
 		/**
 		 * An object of methods to convert from JavaScript's internal character
-		 * representation (UCS-2) to Unicode and back.
+		 * representation (UCS-2) to decimal Unicode code points, and back.
+		 * @see <http://mathiasbynens.be/notes/javascript-encoding>
 		 * @memberOf punycode
 		 * @type Object
 		 */