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

docs: correct downloadTemplate options #144

Merged
merged 1 commit into from Mar 6, 2024
Merged

Conversation

threepointone
Copy link
Contributor

❓ 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

The README claims to accept options that aren't actually accepted (per

giget/src/giget.ts

Lines 12 to 25 in 83eb734

export interface DownloadTemplateOptions {
provider?: string;
force?: boolean;
forceClean?: boolean;
offline?: boolean;
preferOffline?: boolean;
providers?: Record<string, TemplateProvider>;
dir?: string;
registry?: false | string;
cwd?: string;
auth?: string;
install?: boolean;
silent?: boolean;
}
), this patch removes the fields not mentioned in the type

πŸ“ Checklist

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

The docs claim to accept options that aren't actually accepted (per 
https://github.com/unjs/giget/blob/83eb734bb6df993958023e19a363d93d60568248/src/giget.ts#L12-L25), this patch removes the fields not mentioned in the type
@pi0 pi0 changed the title docs: Update README.md to correct options passed to downloadTemplate() docs: correct downloadTemplate options Mar 6, 2024
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks!

@pi0 pi0 merged commit 2398346 into unjs:main Mar 6, 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

Successfully merging this pull request may close these issues.

None yet

2 participants