docs(propfunctionprops): mark propfunctionprops as deprecated

[maiieul]

Overview

What is it?

• Feature / enhancement
• Bug
• Docs / tests / types / typos

Description

Deprecated PropFunctionProps and updated the docs accordingly.

Checklist:

• My code follows the developer guidelines of this project
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• Added new tests to cover the fix / functionality

[netlify]

👷 Deploy request for qwik-insights pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	5b01948

[wmertens]

Do we state somewhere that doing <Cmp foo$={() => "bar"}/> will be automatically changed into <Cmp foo$={$(() => "bar")}/> by the optimizer? (but not <Cmp foo$={"bar"}/>)

[maiieul]

I'm not sure I'm following.

I removed

"using the $ sign" piece, because you could type fn$: () => void and the eslint plugin will still complain.

[wmertens]

Yes but you're changing this part anyway and we want to make sure that the dev understands how to use it and what the optimizer does behind the scenes.

[maiieul]

When I read, "using the $ sign", I understand that fn$: () => void will work but this isn't the right way to do it and the eslint plugin will complain.

I think removing that makes it clearer that what the optimizer needs is "code that's converted to a QRL", whether it is by using $() in the components or QRL<> at the type level.

I removed it because it bugged me when I read it. Like the entire section is about using QRL<>, so if it's written that writing '$' at the end of a word is enough it can be quite confusing.

Btw, I think QRL<> is a good api because it expresses the right type in the form of types. The '$' sign at the prop type level would mean that we add QRL (or PropFnInterface) behind the scenes for the developer. I think it's best that the developer is aware of the QRL<> type directly.

[wmertens]