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

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 2 commits
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
4 changes: 4 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,10 @@ 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 serializes the following types of values passed in `obj`: strings,
Copy link
Member

@joyeecheung joyeecheung Apr 11, 2017 •
edited by TimothyGu
Loading

Choose a reason for hiding this comment

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

Maybe this paragragh can be added to the type annotation of obj above? Using the {Type} syntax would give us links to MDN documentations. Something like

Values should be {String|Number|Boolean|String[]|Number[]|Boolean[]}
(more explanations)

Copy link
Member

Choose a reason for hiding this comment

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

Feel free to ignore, but I would just drop the This method at the front :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@joyeecheung, this is neat -- I didn't know this!
@jasnell, dropped :)

finite numbers, booleans and arrays of the aforementioned types.
Any other input values will be coerced to empty strings
Copy link
Member

@hiroppy hiroppy Apr 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

I think that it is better to use the period(I'm sorry if I'm wrong because I am not native).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right, thanks for pointing it out :)


For example:

```js
Expand Down