-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
122 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# `useAsyncCallback` | ||
|
||
React hook that returns state and a callback for an `async` function or a | ||
function that returns a promise. The state is of the same shape as `useAsync`. | ||
|
||
## Usage | ||
|
||
```jsx | ||
import {useAsyncCallback} from 'react-use'; | ||
|
||
const Demo = (url) => { | ||
const [state, fetch] = useAsyncCallback(async () => { | ||
const response = await fetch(url); | ||
const result = await response.text(); | ||
return result | ||
}), [url]; | ||
|
||
return ( | ||
<div> | ||
{state.loading | ||
? <div>Loading...</div> | ||
: state.error | ||
? <div>Error: {state.error.message}</div> | ||
: state.value && <div>Value: {state.value}</div> | ||
} | ||
<button onClick={() => fetch()}>Start loading</button> | ||
</div> | ||
); | ||
}; | ||
``` | ||
|
||
## Reference | ||
|
||
```ts | ||
useAsyncCallback(fn, deps?: any[]); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import * as React from 'react'; | ||
import {storiesOf} from '@storybook/react'; | ||
import {useAsyncCallback} from '..'; | ||
import ShowDocs from './util/ShowDocs'; | ||
|
||
const fn = () => | ||
new Promise<string>((resolve, reject) => { | ||
setTimeout(() => { | ||
if (Math.random() > 0.5) { | ||
reject(new Error('Random error!')); | ||
} else { | ||
resolve('RESOLVED'); | ||
} | ||
}, 1000); | ||
}); | ||
|
||
const Demo = () => { | ||
const [{loading, error, value}, callback] = useAsyncCallback<string>(fn); | ||
|
||
return ( | ||
<div> | ||
{loading | ||
? <div>Loading...</div> | ||
: error | ||
? <div>Error: {error.message}</div> | ||
: value && <div>Value: {value}</div> | ||
} | ||
<button onClick={() => callback()}>Start</button> | ||
</div> | ||
); | ||
}; | ||
|
||
storiesOf('Side effects|useAsyncCallback', module) | ||
.add('Docs', () => <ShowDocs md={require('../../docs/useAsyncCallback.md')} />) | ||
.add('Demo', () => <Demo/>) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
import { useState, useEffect, useCallback, DependencyList } from 'react'; | ||
import useRefMounted from "./useRefMounted" | ||
|
||
export type AsyncState<T> = | ||
| { | ||
loading: boolean; | ||
error?: undefined; | ||
value?: undefined; | ||
} | ||
| { | ||
loading: false; | ||
error: Error; | ||
value?: undefined; | ||
} | ||
| { | ||
loading: false; | ||
error?: undefined; | ||
value: T; | ||
}; | ||
|
||
const useAsyncCallback = <T>(fn: () => Promise<T>, deps: DependencyList = []): [AsyncState<T>, () => void] => { | ||
const [state, set] = useState<AsyncState<T>>({ | ||
loading: false | ||
}); | ||
|
||
const mounted = useRefMounted(); | ||
|
||
const callback = useCallback(() => { | ||
set({loading: true}); | ||
|
||
fn().then( | ||
value => { | ||
if (mounted.current) { | ||
set({value, loading: false}); | ||
} | ||
}, | ||
error => { | ||
if (mounted.current) { | ||
set({error, loading: false}); | ||
} | ||
} | ||
); | ||
}, deps); | ||
|
||
return [state, callback] | ||
}; | ||
|
||
export default useAsyncCallback; |