slorber / react-async-hook

React hook to handle any async operation in React components, and prevent race conditions
https://sebastienlorber.com/handling-api-request-race-conditions-in-react
1.19k stars 45 forks source link

Do we have API reference documentation? #56

Open pastelmind opened 3 years ago

pastelmind commented 3 years ago

It seems that we don't have API reference documentation. The examples in the README are thorough, but an API Reference section like SWR or React Query would help us quickly look up parameters. It wouldn't have to be large and comprehensive; just 1-2 sentences per each property returned from useAsync() would be fine.

If you need assistance writing a docs section, I'm willing to help. Although I am no expert in documentation.