Add more verbose example for pushEvent & fix type #174
Conversation
|
Is there any progress? |
| export type PushEvent<T = unknown> = (eventName: string) => PushEventData<T> | ||
|
|
||
| export type PushEventData<T = unknown> = (val?: T) => void |
There was a problem hiding this comment.
Any chance we could add a descriptive name for the type T? Makes it a lot easier to follow imo! 馃槅
|
@kyrokstan thanks for this, it was confusing for me at first and I assumed pushEvent doesn't take any params at all, until I clicked through the source and realised it will if I pass it a type. Also, before that, it took me like 15 mins to realise the docs were incorrect and useEvent was what I was looking for. This will really help people trying this lib out for the first time. |
|
@thisRaptori Appreciate you not abandoning this project. Do you think it's a good idea for me to submit a PR for upgrading to |
|
Yeah that'd be great! I'd need to figure out how the publish scripts work unless @troch would be around to handle the publishing, but that shouldn't be an issue 馃槃 |
REOPENING
In https://refract.js.org/usage/pushing-to-props#stateful-apertures it says that the useEvent creates the tuple of pushEvent and fromEvent, the example was pushEvent creating the tuple. It was making me doubt myself 馃
Made new type for PushEvent so it is clear there it can take params
Also added a more verbose use on how to use pushEvent as a prop on the component