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

chore(types): Improve TS types for renderHTML and related functions #4605

Merged
merged 9 commits into from May 2, 2024

Conversation

Tobbe
Copy link
Contributor

@Tobbe Tobbe commented Apr 29, 2024

This PR adds more types to renderHTML() and related functions to make it more type safe

@Tobbe Tobbe marked this pull request as draft April 29, 2024 14:28
@Tobbe Tobbe marked this pull request as ready for review April 29, 2024 15:08
if (Array.isArray(forwardedProtocolHeaderValue)) {
// This really should never happen - only cookies are allowed to have
// multiple values.
throw new Error('invalid protocol header value');
Copy link
Member

Choose a reason for hiding this comment

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

I'd consider this at least a bit bigger than a chore between minor and patch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right. It should have been patch I think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now I kind of want to split this PR up into two. First one where I just make this change, and then one where I improve the types. Do you want me to do that?

Copy link
Member

Choose a reason for hiding this comment

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

I would recommend remove this part in order do not block the types part so I can give it some additional thoughts, because I remember this part might be an array, I barely remember

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed it. But have to type cast instead otherwise TS complains about the types (and rightfully so).

As soon as this is merged I'll open a new PR where I bring this back again. And I'll try to explain exactly how it changes behavior and in what scenarios.

@Tobbe Tobbe changed the title chore(types): Improve TS types for renderHTML patch(types): Improve TS types for renderHTML, and throw error on invalid protocol header value Apr 30, 2024
@verdaccio verdaccio deleted a comment Apr 30, 2024
@verdaccio verdaccio deleted a comment Apr 30, 2024
@Tobbe Tobbe changed the title patch(types): Improve TS types for renderHTML, and throw error on invalid protocol header value patch(types): Improve TS types for renderHTML and related functions May 2, 2024
@Tobbe Tobbe changed the title patch(types): Improve TS types for renderHTML and related functions chore(types): Improve TS types for renderHTML and related functions May 2, 2024
@juanpicado juanpicado merged commit b0946b2 into verdaccio:master May 2, 2024
35 checks passed
@Tobbe Tobbe deleted the tobbe-renderhtml-types branch May 2, 2024 19:04
@Tobbe
Copy link
Contributor Author

Tobbe commented May 2, 2024

Followup PR here, as promised #4613

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants