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

[IMP] types: correctly support Function type for props-validation #1560

Merged
merged 1 commit into from
Dec 4, 2023

Conversation

sdegueldre
Copy link
Contributor

Previously, having a Function as a type in the static props description of a component would only work if the component was not the root component, as the static props description on Component was "any", whereas the static props description on ComponentConstructor was "Schema". This meant that static props description on non-root components was not type-checked, and on root components it was type-checked only on the mount call.

This commit makes it so that static type description is of type "Schema" on Component, now causing static props description to be type-checked, and adds typeof Function to the BaseType union, which allows declaring that a component expects a function as a prop.

Closes #1448

Previously, having a Function as a type in the static props description
of a component would only work if the component was not the root
component, as the static props description on Component was "any",
whereas the static props description on ComponentConstructor was
"Schema". This meant that static props description on non-root
components was not type-checked, and on root components it was
type-checked only on the mount call.

This commit makes it so that static type description is of type "Schema"
on Component, now causing static props description to be type-checked,
and adds `typeof Function` to the `BaseType` union, which allows
declaring that a component expects a function as a prop.

Closes #1448
@sdegueldre
Copy link
Contributor Author

cc @hokolomopo

@ged-odoo ged-odoo merged commit e94428a into master Dec 4, 2023
3 checks passed
@ged-odoo ged-odoo deleted the master-support-function-in-props-description-sad branch December 4, 2023 13:42
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.

BaseType in props validation is missing type FunctionConstructor
2 participants