2.1.2 • Published 4 years ago

react-hook-async v2.1.2

Weekly downloads
9
License
MIT
Repository
github
Last release
4 years ago

React-hook-async

  • Simple way to work with async in your react components, using new React hooks.
  • Support chaining async tasks.
  • Small with no dependency needed

INSTALLATION

yarn add react-hook-async

or

npm i react-hook-async --save

Usage

Performing an async task is common actions when working with React.

With hooks, we usually use something like const [loading, setLoading] = useState(false) to manipulate our UI: show a loading indicator, an error message, ... This thing is trying to make your life a little bit easier when working with async data.

import React, {useState} from 'react';
import axios from 'axios'
import { useAsync } from 'react-hook-async';

const Example = (props) => {

  const [text, setText] = useState("");

  const [apiData, fetchApi] = useAsync([], query => axios.get("<your_api_endpoint_here>", {
    params: {
      q: query
    }
  }))

  const onSearch = () => {
    fetchApi(text);
  };

  const {loading, result, error, lastFetch} = apiData;

  return (
    <div>
      <input type="text" value={text} onChange={e => setText(e.target.value)}/>
      {
        loading
        ? <div>Loading ...</div>
        : error
          ? <div>{error.message}</div>
          : <div>{result}</div>
      }
    </div>
  )
}

export default Example;

API

  • useAsync(initValue, func) : [apiData, execute, reset]

Params:

NameTypeDescription
func() => PromiseA function return promise. The value from promise will be set to apiData.result
initValueanyInitial value for apiData.result

Returned Value:

NameTypeDescription
apiData{loading: boolean, error: null|Error, result: any, lastFetch: Date}Async task state
executeFunctionFunction to perform an async task
resetFunctionFunction to reset apiData

FAQ

Any pull requests & issues are warmly welcome :)

2.1.2

4 years ago

2.1.1

4 years ago

2.0.5

4 years ago

2.1.0

4 years ago

2.0.4

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago