Skip to content

doc: add docu for server.address() for pipe case #12907

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

Closed
Flarna wants to merge 2 commits into from
Closed

doc: add docu for server.address() for pipe case #12907

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9b133b
net: add docu for server.address() for pipe case
Flarna May 8, 2017
73ff8d7
correct review findings
Flarna May 9, 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
Next Next commit
net: add docu for server.address() for pipe case 
Add documentation for net.server.address() for the case it is listening
on a pipe or unix domain socket instead an IP socket.

Fixes: #12895
  • Loading branch information
@Flarna
Flarna committed May 8, 2017
commit a9b133b3b18abb2efdd901b14e25a9ae7f4739c1
7 changes: 5 additions & 2 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,13 @@ added: v0.1.90
-->

Returns the bound address, the address family name, and port of the server
as reported by the operating system.
as reported by the operating system if listening on an IP socket.
Useful to find which port was assigned when getting an OS-assigned address.
Returns an object with `port`, `family`, and `address` properties:
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`.
Copy link
Copy Markdown
Member

@Trott Trott May 8, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: Not sure why the period was added but I don't think it should be there. /cc @nodejs/documentation


For servers listening on a pipe or unix domain sockets the name is returned
Copy link
Copy Markdown
Member

@Trott Trott May 8, 2017

Choose a reason for hiding this comment

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

Nit: Decide whether you want singular or plural and use it for both. pipe + socket or else pipes + sockets

Nit: unix -> UNIX

Nit: comma between socket (or sockets) and the.

as string.
Copy link
Copy Markdown
Member

@Trott Trott May 8, 2017

Choose a reason for hiding this comment

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

Nit: as a string.


Example:

Expand Down