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.

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

typings: Add a few JSDoc typings for the net lib module #38953

Closed
wants to merge 2 commits into from
Closed

typings: Add a few JSDoc typings for the net lib module #38953

wants to merge 2 commits into from

Conversation

festiveelephantseal
Copy link
Contributor

Added a few JSDoc typings for the net lib module.

@github-actions github-actions bot added needs-ci PRs that need a full CI run. net Issues and PRs related to the net subsystem. labels Jun 6, 2021
lib/net.js Outdated
Comment on lines 165 to 171
/**
* Creates a new TCP or IPC server
* @param {{
* allowHalfOpen?: boolean;
* pauseOnConnect?: boolean;
* }} options
* @param {Function} connectionListener
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/**
* Creates a new TCP or IPC server
* @param {{
* allowHalfOpen?: boolean;
* pauseOnConnect?: boolean;
* }} options
* @param {Function} connectionListener
/**
* Creates a new TCP or IPC server
* @param {{
* allowHalfOpen?: boolean;
* pauseOnConnect?: boolean;
* }} [options]
* @param {Function} [connectionListener]

These 2 parameters are optional + formatting to keep consistency with the JSDocs in other lib modules.

targos pushed a commit that referenced this pull request Jul 11, 2021
PR-URL: #38953
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@targos
Copy link
Member

targos commented Jul 11, 2021

Landed in c4f8363

@targos targos closed this Jul 11, 2021
targos pushed a commit that referenced this pull request Jul 11, 2021
PR-URL: #38953
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
targos pushed a commit that referenced this pull request Sep 4, 2021
PR-URL: #38953
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-ci PRs that need a full CI run. net Issues and PRs related to the net subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants