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

New required property "config" is not well documented or may not need to be required #580

Closed
ssmereka opened this issue Feb 18, 2021 · 1 comment · Fixed by #581
Closed
Labels

Comments

@ssmereka
Copy link

Looks like a required property config was recently added to SimpleGitOptions, as seen here. However the documentation does not show this as a required value.

Screen Shot 2021-02-18 at 10 51 11 AM

Should it maybe have been an optional value? eg config?: string[];

Either way, I was updating our dependancies and was a little confused by the error message thrown. To fix I just added the config value.

Screen Shot 2021-02-18 at 10 55 55 AM

steveukx added a commit that referenced this issue Feb 19, 2021
…uld be a `Partial<SimpleGitOptions>` to allow for supplying just some of its properties.

closes #580
@steveukx
Copy link
Owner

Hi, thank you for opening this issue.

The simpleGit builder function actually accepts a Partial<SimpleGitOptions> as all of the properties are optional, this is now reflected in the docs published as 2.35.1

@steveukx steveukx added the bug label Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants