useAsync should return not undefined state.result if initialValue is set

[nikolay-borzov]

Prior Issues

None

What is the current behavior?

state.result returned from useAsync with initialValue set has type Result | undefined. But JSDoc says

Value that will be set on initialisation, before the async function is executed.

I'd expect useAsync handle initialValue as useState does. Look at typings:

function useState<S>(initialState: S | (() => S)): [S, Dispatch<SetStateAction<S>>];
function useState<S = undefined>(): [S | undefined, Dispatch<SetStateAction<S | undefined>>];

Steps to Reproduce

const [{ result: initialData }] = useAsync(
  myAsyncFunction,
  [paramA],
  {
    initialValue: "RESULT",
  },
);

// Has type "string" | undefined
initialData 

What is the expected behavior?

initialData should have type "string"

Environment Details

• @react-hookz/web version: 2.2.0
• react version: 16.14.0
• react-dom version: 16.14.0
• typescript version: 4.3.2
• OS: Windows
• Browser: Chrome
• Did this work in previous versions? Unknown

[xobotyi]

useState is way easier to type that way, but nevertheless i'll fix today

[xobotyi]

🎉 This issue has been resolved in version 3.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀