From 628bc835ae3f47630ccbebe6999a96d69d2b53e4 Mon Sep 17 00:00:00 2001 From: isaacs Date: Mon, 27 Feb 2012 11:09:34 -0800 Subject: [PATCH] doc refactor: querystring --- doc/api/querystring.markdown | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/api/querystring.markdown b/doc/api/querystring.markdown index 1dc9f89f3e..2628e8c388 100644 --- a/doc/api/querystring.markdown +++ b/doc/api/querystring.markdown @@ -1,9 +1,11 @@ -## Query String +# Query String + + This module provides utilities for dealing with query strings. It provides the following methods: -### querystring.stringify(obj, [sep], [eq]) +## querystring.stringify(obj, [sep], [eq]) Serialize an object to a query string. Optionally override the default separator (`'&'`) and assignment (`'='`) @@ -19,7 +21,7 @@ Example: // returns 'foo:bar;baz:qux' -### querystring.parse(str, [sep], [eq], [options]) +## querystring.parse(str, [sep], [eq], [options]) Deserialize a query string to an object. Optionally override the default separator (`'&'`) and assignment (`'='`) @@ -34,12 +36,12 @@ Example: // returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' } -### querystring.escape +## querystring.escape The escape function used by `querystring.stringify`, provided so that it could be overridden if necessary. -### querystring.unescape +## querystring.unescape The unescape function used by `querystring.parse`, provided so that it could be overridden if necessary.