Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add info about serializable types for querystring.stringify() #12313

Closed
wants to merge 3 commits into from
Closed

docs: add info about serializable types for querystring.stringify() #12313

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ed323f
docs: add info about serializable types
shubheksha Apr 10, 2017
31fca1c
doc: add info about other data types
shubheksha Apr 10, 2017
fec24ec
doc: uses {} to link to mdn docs for types
shubheksha Apr 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/api/querystring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ added: v0.1.25
The `querystring.stringify()` method produces a URL query string from a
given `obj` by iterating through the object's "own properties".

This method searializes the following types of values passed in `obj`: strings,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: serializes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I'll fix the typo.
I'm not sure if I understand it correctly but from what I understood from the linked source code was that an empty string is returned if the param passed if not of the aforementioned types. So should I mention this implementation detail? Not sure how to frame it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but from what I understood from the linked source code was that an empty string is returned if the param passed if not of the aforementioned types.

That’s how I read the stringify source code, too. How about adding something like Any other input values will be coerced to empty strings?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good!

finite numbers, booleans and arrays of the aforementioned types.

For example:

```js
Expand Down