doc: add explanations for querystring

- add an article: `decode a non-utf8 string` - explain default and fallback behaviour of `querystring.unescape` PR-URL: nodejs/node-v0.x-archive#9259 Reviewed-by: Julien Gilli <[email protected]>
nodejs · Mar 3, 2015 · c811069 · c811069
1 parent 8fb711e
commit c811069
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/doc/api/querystring.markdown b/doc/api/querystring.markdown
@@ -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 a `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.