## File: README.md

[](https://www.npmjs.com/package/alova)
[](https://github.com/alovajs/alova/actions/workflows/release.yml)
[](https://coveralls.io/github/alovajs/alova?branch=main)
[](https://github.com/alovajs/alova)
[](https://discord.gg/S47QGJgkVb)
[](https://alova.js.org/img/wechat_qrcode.jpg)
[](https://bundlephobia.com/package/alova)




## Sponsors

Thanks to these generous sponsors for supporting alova's development.



## What is alova?

alova (pronounced /əˈləʊva/) is the **request strategy layer for JavaScript**. You've hand-written pagination, forms, uploads and retries countless times — now just pick one of 20+ ready-made request strategies and cut your request code by up to **70%**.

You don't have to throw away the axios or fetch you already know. alova sits right on top of your existing request library and takes over the logic you keep rewriting. One API set spans React, Vue, Svelte, Solid, mini-programs and the server — learn once, use everywhere, so you can focus on business logic on both the client and the server.

Here is a paginated list with prefetch, auto-cache and auto-sync on create/update/delete — about five lines of code:

```javascript
const todoList = (page, size) => alova.Get('/api/todos', { params: { page, size } });

const { loading, data, page, pageSize, pageCount, total } = usePagination(todoList);
// auto pagination · prefetch next page · auto cache sync on create/update/delete
```

## Features

Instead of listing what alova "is", here's what it solves for you:

| The boilerplate you're tired of                         | What alova gives you                                                 | The payoff                                         |
| :------------------------------------------------------ | :------------------------------------------------------------------- | :------------------------------------------------- |
| Hand-writing pagination, forms, uploads, SSE states     | `usePagination` / `useForm` / `useUploader` / `useSSE`               | Up to 70% less boilerplate                         |
| Server-side rate limiting & retries (incl. distributed) | `alova/server`                                                       | Capabilities React Query / SWR simply don't cover  |
| Rebuilding the same logic for every framework           | One API set                                                          | Spans React / Vue / Svelte / Solid / mini-programs |
| Manually maintaining cache invalidation                 | Multi-level cache (L1/L2) + declarative invalidation via `hitSource` | Cache invalidation is no longer painful            |
| Copy-pasting API info between docs and your editor      | `worma`                                                              | API hints & docs show up right inside your editor  |

And of course:

- Easy to use, [watch the video](https://alova.js.org/video-tutorial) to get started in 5 mins.
- Full compatibility with your favorite HTTP clients and UI frameworks.
- 20+ high-performance request strategies (business modules) for building faster apps.
- Request sharing and response cache to improve app performance.
- End-to-end type safety.
- Advanced OpenAPI solution `worma`: from one OpenAPI spec, generate type-safe calling code, TypeScript types, full API docs, and API knowledge for your AI coding assistant.

## When should you use alova?

alova is honest about where it shines — and where a simpler tool is enough:

| Your situation                                                    | Recommendation                                         |
| :---------------------------------------------------------------- | :----------------------------------------------------- |
| Simple CRUD + caching                                             | React Query / SWR are enough                           |
| Complex admin / forms / pagination / uploads                      | ✅ alova is clearly a step ahead                       |
| Cross-platform (Web + mini-program / uni-app / Taro)              | ✅ One API set covers everything                       |
| Server-side request governance (rate limit / retry / distributed) | ✅ alova is almost the only choice                     |
| OpenAPI → type-safe code + AI-friendly API knowledge              | ✅ Pair with `worma` (works out of the box with alova) |

Not sure alova is right for you? Read [When should you NOT use alova?](https://alova.js.org/about/comparison) for the honest reverse list before you commit.

## Is there any difference?

Unlike libraries such as `@tanstack/react-query`, `swrjs`, and `ahooks`'s `useRequest`, alova aims to make API integration very easy and efficient, while maintaining more efficient data interaction and bringing a smoother experience to users.

For the same paginated list, React Query needs roughly 25 lines while alova's `usePagination` takes about 5 — see the [no-BS comparison](https://alova.js.org/about/comparison).

> You can also check [Comparison with other request libraries](https://alova.js.org/about/comparison) to learn more about the differences of alova.

## Join the community

- [Follow us on X](https://x.com/alovajs)
- [Join the Discord](https://discord.gg/S47QGJgkVb)
- [Join the WeChat group](https://alova.js.org/img/wechat_qrcode.jpg)

## We need your support

If you like alova, we are very grateful for giving us a star in the upper right corner, which is a recognition and encouragement for our work.

## Welcome to contribute

We are honored to receive active participation from developers around the world in Issues and Discussions.

We hope to make alova a common project for everyone who is willing to participate. We encourage everyone to become a contributor to the alova community with an open and inclusive attitude. Even if you are a junior developer, as long as your ideas meet the development guidelines of alova, please participate generously.

Effective contributions will win you a certain reputation in the Alova community. Before contributing, please be sure to read the [Contribution Guide](./CONTRIBUTING.md) in detail to ensure your contribution is effective.

## Changelog

[Link](https://github.com/alovajs/alova/releases)

## Contributors

<a href="https://github.com/alovajs/alova/graphs/contributors">

</a>

## LICENSE

[MIT](https://en.wikipedia.org/wiki/MIT_License)

---

## File: examples/vue/README.md

# Vue 3 + Vite

This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).

---

## File: examples/svelte/README.md

# Svelte + Vite

This template should help get you started developing with Svelte in Vite.

## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).

## Need an official Svelte framework?

Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.

## Technical considerations

**Why use this over SvelteKit?**

- It brings its own routing solution which might not be preferable for some users.
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.

This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.

Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.

**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**

Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.

**Why include `.vscode/extensions.json`?**

Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.

**Why enable `checkJs` in the JS template?**

It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.

**Why is HMR not preserving my local component state?**

HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/sveltejs/svelte-hmr/tree/master/packages/svelte-hmr#preservation-of-local-state).

If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.

```js
// store.js
// An extremely simple external store
import { writable } from 'svelte/store';
export default writable(0);
```

---

## File: examples/solid/README.md

# React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

---

## File: examples/server/README.md

# Node.js Express template

This is a Node.js Express project with an HTTP server.

Add your [configuration](https://codesandbox.io/docs/projects/learn/setting-up/tasks) to optimize it for [CodeSandbox](https://codesandbox.io).

## How does this work?

We run `yarn start` to start an HTTP server that runs on http://localhost:8080. You can open new or existing devtools with the + button next to the devtool tabs.

## Resources

- [CodeSandbox — Docs](https://codesandbox.io/docs)
- [CodeSandbox — Community](https://codesandbox.community)

---

## File: examples/react/README.md

# React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

---

## File: packages/vue-options/README.md

# Vue options states hook for alova

Provide vue options support for alova's use hooks. Usually, use hook can only be used in vue's setup, but through the auxiliary function provided by `@alova/vue-options`, you can also use alova's use hook in vue's options, which is perfectly compatible with almost all functions of alova.

> Available in both vue2.7 and vue3

Refer to [alova](https://github.com/alovajs/alova)

## Usage

Please to [vue options states hook documentation](https://alova.js.org/resource/framework/vue-options) for more details.

## Join the community

- [Follow us on X to get the latest updates](https://x.com/alovajs)

- [Join the Discord](https://discord.gg/S47QGJgkVb)

- [Join the WeChat group](https://alova.js.org/img/wechat_qrcode.jpg)

## We need your support

If you like alova, we are very grateful for giving us a star in the upper right corner, which is a recognition and encouragement for our work.

## Welcome to contribute

We are honored to receive active participation from developers around the world in Issues and Discussions.

We hope to make alova a common project for everyone who is willing to participate. We encourage everyone to become a contributor to the alova community with an open and inclusive attitude. Even if you are a junior developer, as long as your ideas meet the development guidelines of alova, please participate generously.

Effective contributions will win you a certain reputation in the Alova community. Before contributing, please be sure to read the [Contribution Guide](https://github.com/alovajs/alova/blob/main/CONTRIBUTING.md) in detail to ensure your contribution is effective.

## Changelog

[Link](https://github.com/alovajs/alova/releases)

## Contributors

<a href="https://github.com/alovajs/alova/graphs/contributors">

</a>

## LICENSE

[MIT](https://en.wikipedia.org/wiki/MIT_License)

---

## File: packages/server/README.md

# Server request strategies for alova

Refer to [alova](https://github.com/alovajs/alova)

## Usage

Please to [server strategies documentation](https://alova.js.org/tutorial/server/strategy) for more details.

## Join the community

- [Follow us on X to get the latest updates](https://x.com/alovajs)

- [Join the Discord](https://discord.gg/S47QGJgkVb)

- [Join the WeChat group](https://alova.js.org/img/wechat_qrcode.jpg)

## We need your support

If you like alova, we are very grateful for giving us a star in the upper right corner, which is a recognition and encouragement for our work.

## Welcome to contribute

We are honored to receive active participation from developers around the world in Issues and Discussions.

We hope to make alova a common project for everyone who is willing to participate. We encourage everyone to become a contributor to the alova community with an open and inclusive attitude. Even if you are a junior developer, as long as your ideas meet the development guidelines of alova, please participate generously.

Effective contributions will win you a certain reputation in the Alova community. Before contributing, please be sure to read the [Contribution Guide](https://github.com/alovajs/alova/blob/main/CONTRIBUTING.md) in detail to ensure your contribution is effective.

## Changelog

[Link](https://github.com/alovajs/alova/releases)

## Contributors

<a href="https://github.com/alovajs/alova/graphs/contributors">

</a>

## LICENSE

[MIT](https://en.wikipedia.org/wiki/MIT_License)

---

## File: packages/psc/README.md

# Process shared cache adapter for alova

Refer to [alova](https://github.com/alovajs/alova)

## Usage

Please to [server strategies documentation](https://alova.js.org/tutorial/server/strategy) for more details.

## Join the community

- [Follow us on X to get the latest updates](https://x.com/alovajs)

- [Join the Discord](https://discord.gg/S47QGJgkVb)

- [Join the WeChat group](https://alova.js.org/img/wechat_qrcode.jpg)

## We need your support

If you like alova, we are very grateful for giving us a star in the upper right corner, which is a recognition and encouragement for our work.

## Welcome to contribute

We are honored to receive active participation from developers around the world in Issues and Discussions.

We hope to make alova a common project for everyone who is willing to participate. We encourage everyone to become a contributor to the alova community with an open and inclusive attitude. Even if you are a junior developer, as long as your ideas meet the development guidelines of alova, please participate generously.

Effective contributions will win you a certain reputation in the Alova community. Before contributing, please be sure to read the [Contribution Guide](https://github.com/alovajs/alova/blob/main/CONTRIBUTING.md) in detail to ensure your contribution is effective.

## Changelog

[Link](https://github.com/alovajs/alova/releases)

## Contributors

<a href="https://github.com/alovajs/alova/graphs/contributors">

</a>

## LICENSE

[MIT](https://en.wikipedia.org/wiki/MIT_License)

---

## File: packages/client/src/statesHook/README.md

# Predefine statesHook

## PreactHook

**Requirements:**

1. Add file `PreactHook.ts` to this folder.
2. Add vitest test environment to this project, you can refer to `vue/react/svelte`.
3. Add unit tests in folder `/test/browser/hooks/preact` to test use hooks in qwikjs, you can copy and modify from other folder such as `vue/react/svelte`.
4. Adapt scene modules of `@alova/scene`, you need to add compatible functions to `src/framework` of [@alova/scene](https://github.com/alovajs/scene/tree/main/src/framework).

## QwikHook

**Requirements:**

1. Add file `QwikHook.ts` to this folder.
2. Add vitest test environment to this project, you can refer to `vue/react/svelte`.
3. Add unit tests in folder `/test/browser/hooks/qwik` to test use hooks in qwikjs, you can copy and modify from other folder such as `vue/react/svelte`.
4. Adapt scene modules of `@alova/scene`, you need to add compatible functions to `src/framework` of [@alova/scene](https://github.com/alovajs/scene/tree/main/src/framework).

## VueHook

`vue.ts` in this folder.

## ReactHook

`react.ts` is in this folder.

## SvelteHook

`svelte.ts` is in this folder.

## SolidHook

`solid.ts` is in this folder.

## VueDemi

`vue-demi.ts` is in this folder.