Skip to content

doc: add socket.readyState - #35262

Merged
Trott merged 1 commit into
nodejs:masterfrom
clarkkozak:net-doc-readyState
Sep 23, 2020
Merged

doc: add socket.readyState#35262
Trott merged 1 commit into
nodejs:masterfrom
clarkkozak:net-doc-readyState

Conversation

@clarkkozak

Copy link
Copy Markdown
Contributor

This PR adds description of socket.readyStatenet documentation

Note that the readyState property was added in v0.5.0: e697cfb

Checklist
  • documentation is changed or added

@clarkkozak
clarkkozak requested a review from a team as a code ownerSeptember 18, 2020 21:30
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/net

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Sep 18, 2020
@clarkkozak

Copy link
Copy Markdown
ContributorAuthor

Also it is still in the current version of Node:

ObjectDefineProperty(Socket.prototype,'readyState',{

@clarkkozak

Copy link
Copy Markdown
ContributorAuthor

I'm unsure on how to add it to the navigation properly. If someone can advise on how to do so that would be awesome.

@addaleaxaddaleax 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.

This will automatically be added to the table of contents, nothing to take care of there :)

Comment threaddoc/api/net.md Outdated
@clarkkozak

Copy link
Copy Markdown
ContributorAuthor

This will automatically be added to the table of contents, nothing to take care of there :)

Right on! Thank you!

@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 @addaleax's comment addressed.

+ description of `socket.readyState`
Note: YAML tag found in commit e697cfb
Co-authored-by: Michael Auderer <mike@silverstone.io>
PR-URL: #35262
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Trott merged commit 81379d1 into nodejs:masterSep 23, 2020
@Trott

Copy link
Copy Markdown
Member

Landed in 81379d1.

Thanks for the contribution! 🎉

@clarkkozak

Copy link
Copy Markdown
ContributorAuthor

Landed in 81379d1.

Thanks for the contribution! 🎉

Right on! Thank you for being open source!

Take care y'all!

MylesBorins pushed a commit that referenced this pull request Sep 24, 2020
+ description of `socket.readyState`
Note: YAML tag found in commit e697cfb
Co-authored-by: Michael Auderer <mike@silverstone.io>
PR-URL: #35262
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Sep 29, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
+ description of `socket.readyState`
Note: YAML tag found in commit e697cfb
Co-authored-by: Michael Auderer <mike@silverstone.io>
PR-URL: nodejs#35262
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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.

5 participants

@clarkkozak@nodejs-github-bot@Trott@addaleax@lpinca