Skip to content

doc: fix return type of server.address() - #22043

Closed
starkwang wants to merge 1 commit into
nodejs:masterfrom
starkwang:fix-server-address-doc
Closed

doc: fix return type of server.address()#22043
starkwang wants to merge 1 commit into
nodejs:masterfrom
starkwang:fix-server-address-doc

Conversation

@starkwang

@starkwangstarkwang commented Jul 31, 2018

Copy link
Copy Markdown
Contributor

server.address() will return a string when listening on a pipe or UNIX domain socket.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Jul 31, 2018
Comment threaddoc/api/net.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Needs to be {Object|string}. Otherwise the generated JSON looks like this:

"return": {
"textRaw": "Returns: {Object} | {string}",
"name": "return",
"type": "Object",
"desc": "| {string}"
},

@lpincalpinca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM with @rubys's comment addressed.

@starkwang
starkwangforce-pushed the fix-server-address-doc branch from e248d93 to 2966e7dCompareAugust 1, 2018 00:08
@vsemozhetbyt

Copy link
Copy Markdown
Contributor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@starkwang

Copy link
Copy Markdown
ContributorAuthor

@starkwang

Copy link
Copy Markdown
ContributorAuthor

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>
@rvaggrvagg mentioned this pull request Aug 13, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.netIssues and PRs related to the net subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@starkwang@nodejs-github-bot@vsemozhetbyt@rubys@lpinca@cjihrig@sagirk@trivikr