Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amplitude/redux-query
A library for managing network state in Redux
https://github.com/amplitude/redux-query
amplitude fetch hacktoberfest middleware react redux redux-query request
Last synced: 5 days ago
JSON representation
A library for managing network state in Redux
- Host: GitHub
- URL: https://github.com/amplitude/redux-query
- Owner: amplitude
- License: other
- Created: 2017-02-10T00:02:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T17:37:54.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:40:13.398Z (2 months ago)
- Topics: amplitude, fetch, hacktoberfest, middleware, react, redux, redux-query, request
- Language: JavaScript
- Homepage: https://amplitude.github.io/redux-query
- Size: 12.3 MB
- Stars: 1,101
- Watchers: 94
- Forks: 67
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# redux-query
[](https://travis-ci.org/amplitude/redux-query)
[](https://codecov.io/gh/amplitude/redux-query)
A library for managing network state in Redux.
## Why use redux-query?
- **It's simply Redux**: Follow best practices for storing and handling network state in Redux, with support for features like optimistic updates and cancellation. There's no magic here, just middleware, actions, selectors, and reducers.
- **It's extensible**: Built to fit most use cases out-of-the-box, but can easily be extended with custom Redux middleware, UI integrations, and network interfaces.
- **It works great with React**: With the provided React hooks and higher-order component in redux-query-react (optional), colocate data dependencies with your components and run requests when components mount or update.
## Docs
- **[Getting Started and Installation](https://amplitude.github.io/redux-query/docs/getting-started)**
- [Entities](https://amplitude.github.io/redux-query/docs/entities)
- [Requests vs. Mutations](https://amplitude.github.io/redux-query/docs/requests-vs-mutations)
- [Query Configs](https://amplitude.github.io/redux-query/docs/query-configs)
- [Query State](https://amplitude.github.io/redux-query/docs/query-state)
- [Error State](https://amplitude.github.io/redux-query/docs/error-state)
- [Network Interfaces](https://amplitude.github.io/redux-query/docs/network-interfaces)
- [Flow Support](https://amplitude.github.io/redux-query/docs/flow)
- [Typescript Support](https://amplitude.github.io/redux-query/docs/typescript)
## Redux API
- [Redux Actions](https://amplitude.github.io/redux-query/docs/redux-actions)
- [Redux Selectors](https://amplitude.github.io/redux-query/docs/redux-selectors)
## React API
- [useRequest](https://amplitude.github.io/redux-query/docs/use-request)
- [useRequests](https://amplitude.github.io/redux-query/docs/use-requests)
- [useMutation](https://amplitude.github.io/redux-query/docs/use-mutation)
- [connectRequest](https://amplitude.github.io/redux-query/docs/connect-request)
## Examples
- [Simple example](https://amplitude.github.io/redux-query/docs/examples/simple): This example is a very simple web app that has only one feature – you can view and update your username. The purpose of this example is to demonstrate how requests and mutations (including optimistic updates) work with redux-query.
- [Hacker News](https://amplitude.github.io/redux-query/docs/examples/hacker-news): This example shows how to use redux-query, redux-query-react, and redux-query-interface-superagent to build a basic Hacker News client.
## Packages
This project is published as multiple packages. redux-query, the core library, is the only required package. redux-query-react is recommended if you are using React in your application. redux-query requires a [network interface](https://amplitude.github.io/redux-query/docs/network-interfaces) which handles the implementation of network requests. You must either use the recommended interface, redux-query-interface-superagent, or supply your own.
| Name | Version | Description |
| :-------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------- |
| [`redux-query`](./packages/redux-query) | [](https://www.npmjs.com/package/redux-query) | The core library for managing network requests with Redux. |
| [`redux-query-react`](./packages/redux-query-react) | [](https://www.npmjs.com/package/redux-query-react) | Library of APIs for integrating redux-query with React components. |
| [`redux-query-interface-superagent`](./packages/redux-query-interface-superagent) | [](https://www.npmjs.com/package/redux-query-interface-superagent) | The recommended network interface that handles network requests. |
## Upgrade guides
- [1.x to 2.x](https://amplitude.github.io/redux-query/docs/upgrade-guides/v1-to-v2)
- [2.x to 3.x](https://amplitude.github.io/redux-query/docs/upgrade-guides/v2-to-v3)
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md).
## License
[MIT](https://github.com/amplitude/redux-query/blob/master/LICENSE)
## About
Brought to you by [Amplitude Engineering](https://amplitude.com/engineering). We're hiring!