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

fix: support optional params in ParsedArgs types #72

Closed
wants to merge 3 commits into from

Conversation

Barbapapazes
Copy link
Member

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR allow the type ParsedArgs to support the required boolean property. Depending on the value of this property, the args coud be type | undefined or type.

  • positional, If required is false, the type is type | undefined. If required is false and a default value is provided, the type is type. If required is true, the type is type. If required does not exist, the type is type.
  • string, If required is false, the type is type | undefined. If required is false and a default value is provided, the type is type. If required is true, the type is type. If required does not exist, the type is undefined.
  • boolean, If required is false, the type is type | undefined. If required is false and a default value is provided, the type is type. If required is true, the type is type. If required does not exist, the type is undefined.

Improve DX.

Should I add some type tests?

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@Barbapapazes Barbapapazes added the enhancement New feature or request label Sep 13, 2023
@Barbapapazes Barbapapazes self-assigned this Sep 13, 2023
@Barbapapazes Barbapapazes mentioned this pull request Sep 13, 2023
8 tasks
@pi0
Copy link
Member

pi0 commented Mar 18, 2024

Thanks for this PR. Types defenitly need refactor but i think first i need to make some structure changes and that likely will conflict with this.

@pi0 pi0 closed this Mar 18, 2024
@pi0 pi0 deleted the fix/types-required-args branch March 18, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants