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

deprecation(uuid): deprecate v1.generate() signature with buf and offset parameters #4880

Merged
merged 1 commit into from
May 29, 2024

Conversation

iuioiua
Copy link
Contributor

@iuioiua iuioiua commented May 29, 2024

This PR deprecates the v1.generate() signature with the optional buf and offset arguments and number[] return type. These settings are unneeded in almost all cases and gave the function a shape that differed from the other generate() functions within @std/uuid. The function also went against Deno's Style Guide, which required functions to have only one optional argument (see https://docs.deno.com/runtime/manual/references/contributing/style_guide#exported-functions-max-2-args-put-the-rest-into-an-options-object).

Pre-requisite for #4877

@iuioiua iuioiua requested a review from kt3k as a code owner May 29, 2024 08:56
@github-actions github-actions bot added the uuid label May 29, 2024
Copy link

codecov bot commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.36%. Comparing base (fc3d376) to head (de26089).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4880      +/-   ##
==========================================
- Coverage   92.36%   92.36%   -0.01%     
==========================================
  Files         488      488              
  Lines       41603    41601       -2     
  Branches     5407     5407              
==========================================
- Hits        38425    38423       -2     
  Misses       3122     3122              
  Partials       56       56              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

LGTM

@kt3k
Copy link
Member

kt3k commented May 29, 2024

BTW I think this can be skipped if the next version of @std/uuid is 1.0.0-rc.1

@iuioiua
Copy link
Contributor Author

iuioiua commented May 29, 2024

We should merge this and other non-breaking changes for @std/[email protected]. Then we can do @std/[email protected], including the breaking changes. WDYT?

@iuioiua iuioiua merged commit 5ffeab7 into main May 29, 2024
14 checks passed
@iuioiua iuioiua deleted the uuid-deprecate-v1-generate branch May 29, 2024 09:07
@kt3k
Copy link
Member

kt3k commented May 29, 2024

We should merge this and other non-breaking changes for @std/[email protected]. Then we can do @std/[email protected], including the breaking changes. WDYT?

That works too. Ok. Let's do that.

@iuioiua iuioiua mentioned this pull request May 30, 2024
2 tasks
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 this pull request may close these issues.

2 participants