Skip to content

typings: add a few JSDoc typings for child_process #38951

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
festiveelephantseal wants to merge 2 commits into from
Closed

typings: add a few JSDoc typings for child_process #38951

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e1ecee
typings: add a few JSDoc typings for child_process
festiveelephantseal Jun 6, 2021
5f7501c
typings: fix JSDoc typings for child_process
festiveelephantseal Jun 6, 2021
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
19 changes: 19 additions & 0 deletions lib/child_process.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ const {

const MAX_BUFFER = 1024 * 1024;

/**
* Spawns a new Node.js insatnce
* using the execPath of the parent process
* @param {string} modulePath
Copy link
Contributor

@aduh95 aduh95 Jun 6, 2021

Choose a reason for hiding this comment

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

It seems this is lacking a definition for the optional parameters (args and options).

* @param {string[]} args
* @param {Object} options
* @returns {ChildProcess}
*/

function fork(modulePath /* , args, options */) {
validateString(modulePath, 'modulePath');

Expand Down Expand Up @@ -206,6 +215,16 @@ ObjectDefineProperty(exec, promisify.custom, {
value: customPromiseExecFunction(exec)
});

/**
* Spawns the new specified excutable file
* as a new process
* @param {string} file
Copy link
Contributor

@aduh95 aduh95 Jun 6, 2021

Choose a reason for hiding this comment

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

Ditto here (args, options, and callback).

* @param {string[]} args
* @param {Object} options
* @param {Function} callback
* @returns {ChildProcess}
*/

function execFile(file /* , args, options, callback */) {
let args = [];
let callback;
Expand Down