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

refactor: fix typo in removeMeta option for removeItem #281

Merged
merged 4 commits into from
Aug 7, 2023

Conversation

Timbological
Copy link
Contributor

πŸ”— Linked issue

#280

❓ 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

Fixed typo of removeMeta option in removeItem function as "removeMata", updated docs to reflect default behaviour or removeItem function when removeMeta argument is not specified

It resolves the problem of the option being spelled incorrectly and therefore the correct spelling not working. It would be a breaking change if someone has realized that it was spelled incorrectly and therefore has been using the incorrect spelling.
It also corrects the docs which imply that not providing a removeMeta argument to removeItem will result in the metadata being deleted which is not the case

Resolves #280

πŸ“ Checklist

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

@nuxt-studio
Copy link

nuxt-studio bot commented Jul 31, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
unstorage Edit on Studio β†—οΈŽ View Live Preview 358e29b

@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Merging #281 (c24195e) into main (a0a1cdd) will increase coverage by 0.39%.
Report is 1 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head c24195e differs from pull request most recent head 358e29b. Consider uploading reports for the commit 358e29b to get more accurate results

@@            Coverage Diff             @@
##             main     #281      +/-   ##
==========================================
+ Coverage   76.55%   76.94%   +0.39%     
==========================================
  Files          26       26              
  Lines        3169     3223      +54     
  Branches      473      473              
==========================================
+ Hits         2426     2480      +54     
  Misses        742      742              
  Partials        1        1              
Files Changed Coverage Ξ”
src/index.ts 100.00% <100.00%> (ΓΈ)
src/storage.ts 85.39% <100.00%> (ΓΈ)
src/types.ts 100.00% <100.00%> (ΓΈ)

@pi0 pi0 changed the title fix: removeMata option typo in removeItem function and corrected default behaviour in docs refactor: fix type in removeMeta option for removeItem Aug 7, 2023
@pi0 pi0 changed the title refactor: fix type in removeMeta option for removeItem refactor: fix typo in removeMeta option for removeItem Aug 7, 2023
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 for sharp eyes πŸ’― (i have added a small backward compatibility check to avoid breaking users)

@pi0 pi0 merged commit da1d16d into unjs:main Aug 7, 2023
2 checks passed
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.

removeMeta option for removeItem type and default value incorrect in docs
2 participants