Skip to content

Conversation

starkwang
Copy link
Contributor

@starkwang starkwang commented Jul 31, 2018

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
Collaborator

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Jul 31, 2018
doc/api/net.md Outdated
Copy link
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}"
                  },

Copy link
Member

@lpinca lpinca left a comment

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 starkwang force-pushed the fix-server-address-doc branch from e248d93 to 2966e7d Compare August 1, 2018 00:08
@vsemozhetbyt
Copy link
Contributor

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

@starkwang
Copy link
Contributor Author

@starkwang
Copy link
Contributor Author

Landed in 049c046

@starkwang starkwang closed this Aug 3, 2018
starkwang added a commit that referenced this pull request Aug 3, 2018
PR-URL: #22043
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
targos pushed a commit that referenced this pull request Aug 4, 2018
PR-URL: #22043
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants