-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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: add missing options to HtmxConfig type #2026
Conversation
Please rebase + retarget against dev, otherwise looks good |
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, thank you!
* The type of binary data being received over the WebSocket connection | ||
* @default blob | ||
*/ | ||
wsBinaryType?: Blob; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the type is wrong here, wsBinaryType
should be a string as per the Websocket.binaryType doc as it's a parameter passed to the latter
Its default value is "blob"
but not of type blob if I'm not mistaken.
It can also take only 2 values which might be relevant to specify them here to act as an enum?
Value
A string
"blob"
Use Blob objects for binary data. This is the default value.
"arraybuffer"
Use ArrayBuffer objects for binary data.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahhh, I think you're right. I can make another PR to amend.
I also realised after that methodsThatUseUrlParams?: string[];
is probably not strict enough and it should be ('get' | 'post' | ...etc )[]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just cut a new one and reference this one, no problem
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Description
When playing around with View Transitions, I noticed that the
globalViewTransitions
property, as well as some other options, were missing from theHtmxConfig
type. This PR aligns theHtmkConfig
with the options listed on htmx.org.Corresponding issue:
Testing
None
Checklist
master
for website changes,dev
forsource changes)
approved via an issue
npm run test
) and verified that it succeeded