https://github.com/vivek12345/react-polling-hook
Polling an api made easy with react-hooks 🔔
https://github.com/vivek12345/react-polling-hook
hooks polling-service react react-hooks react-polling
Last synced: 23 days ago
JSON representation
Polling an api made easy with react-hooks 🔔
- Host: GitHub
- URL: https://github.com/vivek12345/react-polling-hook
- Owner: vivek12345
- License: mit
- Created: 2018-11-08T21:44:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T17:27:23.000Z (over 2 years ago)
- Last Synced: 2025-04-28T16:10:00.391Z (23 days ago)
- Topics: hooks, polling-service, react, react-hooks, react-polling
- Language: JavaScript
- Size: 788 KB
- Stars: 33
- Watchers: 1
- Forks: 5
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔔 react-polling-hook
[](#contributors)
[](https://travis-ci.com/vivek12345/react-polling-hook)
> ⚠️ Not yet published on npm and is not being currently developed. If you still need it, please fork the repo.
Easy to use polling service built with react that uses the new React Hooks(Note: This is an alpha release)
**Note: Read more about react hooks here [React hooks](https://reactjs.org/docs/hooks-intro.html)**
### 🚚 Installation
```
yarn add react-polling-hook
```
or
```
npm i react-polling-hook --save
```
### ⚡️ Usage
```javascript
import React, { Fragment } from 'react';
import { usePolling } from 'react-polling-hook';
const App = () => {
const [isPolling, startPolling, stopPolling] = usePolling({
url: 'url to poll',
interval: 3000, // in milliseconds(ms)
retryCount: 3, // this is optional
onSuccess: () => console.log('handle success'),
onFailure: () => console.log('handle failure'), // this is optional
method: 'GET',
headers: "headers object", // this is optional
body: JSON.stringify(data) // data to send in a post call. Should be stringified always
});
return (
{isPolling ? (
Hello I am polling
Stop Polling
) : (
Hello I have stopped polling
Start Polling
)}
);
}
```
## 📒 Api
### 🔔 react-polling-hook
| Props | Type | Default | Description |
|-------------------------|------------------------|-----------|-----------------------------------------------------------------------------------------------------|
| url | string | null | url/api to poll |
| interval | number | 3000 | Interval of polling |
| retryCount | number | 0 | Number of times to retry when an api polling call fails |
| onSuccess | function | - | Callback function on successful polling. This should return true to continue polling |
| onFailure | function | () => {} | Callback function on failed polling or api failure |
| method | string | GET | HTTP Method of the api to call |
| headers | object | - | Any specific http headers that need to be sent with the request |
| body | object | - | The data that need to be sent in a post/put call
#### onSuccess (required)
This function will be called every time the polling service gets a successful response.
You should return true to continue polling and false to stop polling. It has the following signature:
```javascript
function onSuccess(response) {
// You can do anything with this response, may be add to an array of some state of your react component
// return true to continue polling
// return false to stop polling
}
```
#### onFailure (not compulsory field)
This function will be called every time the polling service gets a failure response from the api, it can be 401 or 500 or any failure status code.
You can do some cleaning up of your variables or reseting the state here.
```javascript
function onFailure(error) {
// You can log this error to some logging service
// clean up some state and variables.
}
```
## 👍 Contribute
Show your ❤️ and support by giving a ⭐. Any suggestions and pull request are welcome !
### 📝 License
MIT © [viveknayyar](https://github.com/vivek12345)
## 👷 TODO
- [x] Complete README
- [ ] Add Examples and Demo
- [ ] Test Suite
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Vivek Nayyar](https://www.viveknayyar.in/)
[📖](https://github.com/vivek12345/react-polling-hook/commits?author=vivek12345 "Documentation") [💻](https://github.com/vivek12345/react-polling-hook/commits?author=vivek12345 "Code") [🎨](#design-vivek12345 "Design") [💡](#example-vivek12345 "Examples") |
| :---: |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!