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

Document opts.prog and opts.args #9

Closed
edmorley opened this issue Oct 5, 2018 · 3 comments
Closed

Document opts.prog and opts.args #9

edmorley opened this issue Oct 5, 2018 · 3 comments

Comments

@edmorley
Copy link

edmorley commented Oct 5, 2018

Hi

Looking at the README it seemed like there was no way to customise the args passed (needed for yarnpkg/yarn#6493), however there are some additional undocumented options that would be good to add to the README:

let prog = opts.prog

let args = opts.args || ''

@zkochan
Copy link
Member

zkochan commented Oct 5, 2018

you already used them and they work correctly? I don't have objections adding them to the readme

let's just double check that they are covered with tests

@edmorley
Copy link
Author

Sorry for the delayed reply. I didn't get as far as trying them, since I realised a different approach would likely be required for the use-case in that yarn issue.

@ExE-Boss
Copy link
Member

They are documented in the type definition file:

cmd-shim/index.d.ts

Lines 24 to 32 in 56ec114

/**
* The path to the executable file.
*/
prog?: string;
/**
* The arguments to initialize the `node` process with.
*/
args?: string;

@edmorley edmorley closed this as not planned Won't fix, can't repro, duplicate, stale Feb 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants