Skip to content

Fix:changes the paginate function to allow readonly array types #13213

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

Merged

Conversation

joshmkennedy
Copy link
Contributor

Changes

Resolves this issue #13196

The paginate function allows for readonly arrays.

Testing

Just types were changed.

Docs

Just types were added

Copy link

changeset-bot bot commented Feb 11, 2025

🦋 Changeset detected

Latest commit: ec404b1

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr labels Feb 11, 2025
@joshmkennedy joshmkennedy changed the title changes the paginate function to allow readonly array types Fix:changes the paginate function to allow readonly array types Feb 11, 2025
Copy link

codspeed-hq bot commented Feb 11, 2025

CodSpeed Performance Report

Merging #13213 will not alter performance

Comparing joshmkennedy:fix-paginate-readonly-array-type (ec404b1) with main (9d56602)

Summary

✅ 6 untouched benchmarks

@ematipico
Copy link
Member

Is the change backwards compatible? Or does that mean that now all arrays must be passed with the readonly signature?

@joshmkennedy
Copy link
Contributor Author

joshmkennedy commented Feb 11, 2025

Yes, it is backwards compatible. You can still pass in mutable arrays. Typescript will only complain when paginate attempts to mutate the array.

Here is a ts playground showing that.

@ascorbic ascorbic merged commit 6bac644 into withastro:main Feb 12, 2025
17 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs pr pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants