Skip to content

Commit ffe214d

Browse files
committed
Documentation: useAff
1 parent a797ad5 commit ffe214d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: src/React/Basic/Hooks/Aff.purs

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ derive instance ntUseAff :: Newtype (UseAff key a hooks) _
1717
type Result a
1818
= Maybe (Either Error a)
1919

20+
-- | `useAff` is used for asynchronous effects or `Aff`. The asynchronous effect
21+
-- | is re-run whenever the key changes. If another `Aff` runs when the key
22+
-- | changes before the previous async resolves, it will cancel the previous in
23+
-- | flight async effect.
2024
useAff ::
2125
forall key a.
2226
Eq key =>

0 commit comments

Comments
 (0)