Skip to content

Latest commit

 

History

History
71 lines (41 loc) · 4.48 KB

README.md

File metadata and controls

71 lines (41 loc) · 4.48 KB

header

Powerful fetching middleware, flexible HTTP client management for various frameworks

GitHub License Codacy grade

English   •   한국어

What is Query Adaptor?

Fetch API only provides basic functionality, often requiring developers to implement additional features themselves. For example, automatic retries on request failure, renewing authentication tokens, logging requests and responses, and canceling requests are not supported by the Fetch API and need to be manually added. Additionally, there's the hassle of repeatedly writing the same configurations.

To overcome these limitations, Query Adaptor was developed. As the name suggests, it allows for simple, query-like usage that reduces the complexity of network communication logic. Use it declaratively, like making a simple query, to lessen the burden of handling network communication and focus on your core logic!

Key features

  • 🧰 Extension of Fetch API: Provides richer functionality than Fetch API. With features like Instance, Interceptor, and Effect, it minimizes complex configurations and enables flexible HTTP communication.
  • 🧩 Support for Various Environments: Designed for easy use in various environments. Query Adaptor works seamlessly in specialized Fetch API environments like Next.js, React Native, and Tauri by simply being used as an adapter.
  • ✨ Strong Type Safety: Fully supports TypeScript and requires only the necessary types for precise type inference. This minimizes unnecessary types and ensures robust type safety.

Packages

query-adaptor · npm version npm downloads npm bundle size

Provides core features of Query Adaptor.

  • query
  • createQueryAdaptor
  • fetchOptions

@query-adaptor/react-query · npm version npm downloads npm bundle size

Provides features to easily use Query Adaptor with React Query.

  • queryFetchFn
  • queryFetchKey

Official Documentation

Visit the official documentation for detailed information on installation, usage, and more.

Contributing

We welcome contribution from everyone in the community. Read below for detailed contribution guide.

CONTRIBUTING.md

Contributors

contributors

License

See LICENSE for more information.

MIT © gwansikk