doc: add explanations for querystring
authorRobert Kowalski <rok@kowalski.gd>
Sat, 21 Feb 2015 00:03:14 +0000 (01:03 +0100)
committercjihrig <cjihrig@gmail.com>
Tue, 3 Mar 2015 15:03:42 +0000 (10:03 -0500)
 - add an article: `decode a non-utf8 string`
 - explain default and fallback behaviour of `querystring.unescape`

PR-URL: https://github.com/joyent/node/pull/9259
Reviewed-by: Julien Gilli <julien.gilli@joyent.com>
doc/api/querystring.markdown

index 0168889..3714497 100644 (file)
@@ -43,7 +43,7 @@ Options object may contain `maxKeys` property (equal to 1000 by default), it'll
 be used to limit processed keys. Set it to 0 to remove key count limitation.
 
 Options object may contain `decodeURIComponent` property (`querystring.unescape` by default),
-it can be used to decode `non-utf8` encoding string if necessary.
+it can be used to decode `non-utf8` encoding string if necessary.
 
 Example:
 
@@ -67,3 +67,7 @@ provided so that it could be overridden if necessary.
 
 The unescape function used by `querystring.parse`,
 provided so that it could be overridden if necessary.
+
+It will try to use `decodeURIComponent` in the first place,
+but if that fails it falls back to a safer equivalent that
+doesn't throw on malformed URLs.