# @ts-rest/vue-query
> vue-query client integration for @ts-rest
Latest version **3.52.1** (published 2025-03-04) · MIT license · 0 weekly downloads
## Install
```sh
npm install @ts-rest/vue-query
pnpm add @ts-rest/vue-query
yarn add @ts-rest/vue-query
bun add @ts-rest/vue-query
```
## Health
**Score 50/100 (C)** — status: stable.
Positive: has types; esm support; no vulnerabilities; has provenance.
Warnings: low downloads.
Negative: stale.
## Facts
| | |
|---|---|
| Version | 3.52.1 |
| Published | 2025-03-04 |
| First published | 2023-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 3332 |
| Maintainers | oliverbutler, gabrola |
| Keywords | rpc, rest, typescript, typescript-rest, vue-query, nestjs, http, api, type safe |
## Links
- npm: https://www.npmjs.com/package/@ts-rest/vue-query
- Repository: https://github.com/ts-rest/ts-rest
- Homepage: https://github.com/ts-rest/ts-rest#readme
- Issues: https://github.com/ts-rest/ts-rest/issues
- npm.io page: https://npm.io/package/@ts-rest/vue-query
## Alternatives
- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads
## Recent versions
- 3.52.1 (latest) — 2025-03-04
- 3.53.0-rc.1 (rc) — 2025-06-02
- 3.53.0-alpha.3 (alpha) — 2025-05-31
- 3.49.0-beta.4 (beta) — 2024-07-29
- 3.53.0-rc.0 — 2025-06-01
- 3.53.0-alpha.2 — 2025-05-28
- 3.53.0-alpha.1 — 2025-05-27
- 3.53.0-alpha.0 — 2025-05-26
- 3.52.0 — 2025-02-11
- 3.52.0-alpha.1 — 2025-02-10
- 3.52.0-alpha.0 — 2025-02-10
- 3.51.1 — 2025-02-09
- 3.51.0 — 2024-08-22
- 3.50.0 — 2024-08-15
- 3.49.4 — 2024-08-15
- … 45 more at https://npm.io/package/@ts-rest/vue-query/versions
## README
# ts-rest
Incrementally adoptable RPC-like client and server helpers for a magical end to end typed experience 🪄
Join us on Discord for help, feedback, and discussions!
# Introduction
ts-rest offers a simple way to define a contract for your API, which can be both consumed and implemented by your application, giving you end to end type safety without the hassle or code generation.
### Features
- End-to-end type safety 🛟
- RPC-like client side API ⚡️
- Small Bundle Size 📉
- No Code Generation 🏃♀️
- Zod support for runtime validation 🔒
- Full optional OpenAPI integration 📝
### Super Simple Example
Easily define your API contract somewhere shared
```typescript
const contract = c.router({
getPosts: {
method: 'GET',
path: '/posts',
query: z.object({
skip: z.number(),
take: z.number(),
}), // <-- Zod schema
responses: {
200: c.type(), // <-- OR normal TS types
},
headers: z.object({
'x-pagination-page': z.coerce.number().optional(),
}),
},
});
```
Fulfill the contract on your server, with a type-safe router:
```typescript
const router = s.router(contract, {
getPosts: async ({ params: { id } }) => {
return {
status: 200,
body: prisma.post.findUnique({ where: { id } }),
};
},
});
```
Consume the api on the client with a RPC-like interface:
```typescript
const result = await client.getPosts({
headers: { 'x-pagination-page': 1 },
query: { skip: 0, take: 10 },
// ^-- Fully typed!
});
```
## Quickstart
Create a contract, implement it on your server then consume it in your client. Incrementally adopt, trial it with your team, then get shipping faster.
## Contributors ✨
MASSIVE Thanks to all of these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)), who have helped make ts-rest possible:
## Star History
Since our first commit in 2022 we've been growing steadily. We're proud of our progress and we're excited about the future.
Join us on Discord for help, feedback, and discussions!
---
_Source: https://npm.io/package/@ts-rest/vue-query · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
