doc: fix return type of server.address() #22043
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
sagirk
approved these changes
Jul 31, 2018
rubys
suggested changes
Jul 31, 2018
doc/api/net.md
Outdated
| @@ -114,7 +114,7 @@ Emitted when the server has been bound after calling [`server.listen()`][]. | |||
| added: v0.1.90 | |||
| --> | |||
|
|
|||
| * Returns: {Object} | |||
| * Returns: {Object} | {string} | |||
There was a problem hiding this comment.
Needs to be {Object|string}. Otherwise the generated JSON looks like this:
"return": {
"textRaw": "Returns: {Object} | {string}",
"name": "return",
"type": "Object",
"desc": "| {string}"
},
starkwang
force-pushed
the
fix-server-address-doc
branch
from
e248d93
to
2966e7d
Compare
trivikr
approved these changes
Aug 1, 2018
vsemozhetbyt
approved these changes
Aug 1, 2018
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
rubys
approved these changes
Aug 1, 2018
cjihrig
approved these changes
Aug 1, 2018
|
CI before landing: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/412/ |
|
Landed in 049c046 |
starkwang
added a commit
that referenced
this pull request
Aug 3, 2018
PR-URL: #22043 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
targos
pushed a commit
that referenced
this pull request
Aug 4, 2018
PR-URL: #22043 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This was referenced Aug 16, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
server.address()will return a string when listening on a pipe or UNIX domain socket.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes