Skip to content
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

Jump to bottom

doc: add socket.readyState #35262

Merged
merged 1 commit into from
Sep 23, 2020
Merged

doc: add socket.readyState #35262

merged 1 commit into from
Sep 23, 2020

Conversation

clarkkozak
Copy link
Contributor

This PR adds description of socket.readyState net 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 owner September 18, 2020 21:30
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/net

@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 Sep 18, 2020
@clarkkozak
Copy link
Contributor Author

Also it is still in the current version of Node:

node/lib/net.js

Line 524 in c66e647

ObjectDefineProperty(Socket.prototype, 'readyState', {

@clarkkozak
Copy link
Contributor Author

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.

addaleax
addaleax approved these changes Sep 20, 2020
View reviewed changes
Copy link
Member

@addaleax addaleax left a comment

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 :)

doc/api/net.md Outdated Show resolved Hide resolved
@clarkkozak
Copy link
Contributor Author

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

Right on! Thank you!

lpinca
lpinca approved these changes Sep 20, 2020
View reviewed changes
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 @addaleax's comment addressed.

@clarkkozak @Trott
doc: add socket.readyState
81379d1 
+ description of `socket.readyState`

Note: YAML tag found in commit e697cfb

Co-authored-by: Michael Auderer <[email protected]>

PR-URL: #35262
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@Trott Trott merged commit 81379d1 into nodejs:master Sep 23, 2020
@Trott
Copy link
Member

Trott commented Sep 23, 2020

Landed in 81379d1.

Thanks for the contribution! 🎉

@clarkkozak
Copy link
Contributor Author

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
@clarkkozak @MylesBorins
doc: add socket.readyState
ec6b78a 
+ description of `socket.readyState`

Note: YAML tag found in commit e697cfb

Co-authored-by: Michael Auderer <[email protected]>

PR-URL: #35262
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Sep 29, 2020
Merged
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@clarkkozak @joesepi
doc: add socket.readyState
d3d7e03 
+ description of `socket.readyState`

Note: YAML tag found in commit e697cfb

Co-authored-by: Michael Auderer <[email protected]>

PR-URL: nodejs#35262
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@Trott Trott Trott approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@clarkkozak @nodejs-github-bot @Trott @addaleax @lpinca