From 5d821fe0beec775fa3fbb0fd7ac1cbc3fff983c5 Mon Sep 17 00:00:00 2001 From: Robert Kowalski Date: Sat, 21 Feb 2015 01:03:14 +0100 Subject: [PATCH] doc: add explanations for querystring - 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 --- doc/api/querystring.markdown | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/api/querystring.markdown b/doc/api/querystring.markdown index ed1ce9f7c05..5f020330368 100644 --- 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.