Why there is no documentation about the @hook/@vue event?

[schirrel]

I just discovered a few minutes that theres a @hook(@vue on vue 3) event that can be used on vue components, and i had to confess that it is extremelly usefull with dynamic components. Such @hook:mounted or @hook:destroyed.
I am curious on why there's no mention of this in the docs, both vue 2 and 3. The only way that shows a bit of it is in the migration guide VNode Lifecycle Events section, but other than that no such a thing is presente
Is this a kindof "easter egg" or a functionality that is no intendeed to be used?

I'de search inside the repo and the documentation and haven't found about this. Maybe it shown on any other way?

[MangoMarcus]

I thought I was going mad when I saw this syntax being used and could find no reference in the docs, seems a strange omission!

[a-kriya]

@NataliaTepluhina

[NataliaTepluhina]

This functionality is not intended to be used in user applications; that's why we decided not to document it.

[schirrel]

Thanks @NataliaTepluhina so it means that we should avoid to use cuz it may go away?

[absidue]

Undocumented means no stability guarantees, so yes may go away or may change behaviour, neither of which you would be warned about in the docs or a changelog and if any changes to those undocumented APIs do break your code, don't expect anyone from the Vue team to help you out.

[NataliaTepluhina]

@schirrel @absidue is correct: you can use the functionality, but it's at your own risk. For example, you can see that the breaking change to the name of these events was done in the minor version (which is not usually done for public-facing API).

[skirtles-code]

@NataliaTepluhina @vue:mounted is used in one of the official examples:

https://vuejs.org/examples/#todomvc

While I do understand the decision not to document those events, it does seem a little contradictory to have it in an example aimed at beginners. I think that example illustrates that there are valid use cases for it in user applications, so perhaps the decision not to document it should be re-evaluated?