@cratestack/adapter-rtk

中文文档
0.19.3发布于 2026/11/09MITTypeScriptES Module构建来源已验证近 30 天下载 2669

An RTK Query BaseQueryFn adapter over CrateStack's generated TypeScript RPC client.

原始使用文档

@cratestack/adapter-rtk

An RTK Query BaseQueryFn adapter over CrateStack's generated TypeScript RPC client (transport rpc schemas) — dispatches every endpoint through the same runtime and RpcLink chain (@cratestack/link-batch, @cratestack/link-logger, etc.) the rest of the generated client uses, instead of RTK Query's default fetchBaseQuery reimplementing the wire protocol.

This package is the primitive; cratestack generate-typescript --rtk (cratestack#906) generates a full createApi endpoint set on top of it — src/rtk-api.ts's createCratestackRtkApi(client), one entry per model operation and per procedure, with providesTags/invalidatesTags derived from the schema rather than hand-written. The hand-written shape below is still exactly what that generated code does under the hood, and is the reference for anyone customizing beyond the generator's output or writing a --template-dir override for rtk-rpc.ts.j2.

Usage

import { createRpcBaseQuery } from "@cratestack/adapter-rtk";
import { createApi } from "@reduxjs/toolkit/query/react";
import { client } from "./generated/client"; // your project's generated client instance

export const api = createApi({
  reducerPath: "api",
  baseQuery: createRpcBaseQuery(client.runtime),
  endpoints: (builder) => ({
    getWidget: builder.query<Widget, number>({
      query: (id) => ({ opId: "model.Widget.get", input: { id } }),
    }),
    createOrder: builder.mutation<Order, CreateOrderInput>({
      query: (input) => ({ opId: "model.Order.create", input }),
    }),
  }),
});

createRpcBaseQuery takes an RpcCaller — any object with a call<I, O>(opId, input, options?) method, which is exactly the shape of a generated client's public .runtime field (CratestackRpcRuntime). A failed call surfaces as { status: "RPC_ERROR", data: RpcErrorBody } when the server returned a structured error, or { status: "RPC_TRANSPORT_ERROR" } for a network failure with no such body.

版本与发布记录

@cratestack/adapter-rtk 共发布 67 个版本,首次发布于 2026/08/02;过去 12 个月发布了 67 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.19.3latest2026/11/091 天前
0.19.22026/11/091 天前
0.19.12026/11/092 天前
0.19.02026/11/092 天前
0.18.12026/11/073 天前
0.18.02026/11/074 天前

关于 @cratestack/adapter-rtk 的常见问题

@cratestack/adapter-rtk 是什么?

An RTK Query BaseQueryFn adapter over CrateStack's generated TypeScript RPC client.

如何安装 @cratestack/adapter-rtk?

在项目目录运行 npm install @cratestack/adapter-rtk,或使用 pnpm add / yarn add / bun add。

@cratestack/adapter-rtk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cratestack/adapter-rtk 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cratestack/adapter-rtk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cratestack/adapter-rtk 可以商用吗?

@cratestack/adapter-rtk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cratestack/adapter-rtk 的下载量有多少?

根据 npm 官方下载统计,@cratestack/adapter-rtk 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,669 次,日均约 89 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cratestack/adapter-rtk 还在维护吗?

最新版本 0.19.3 发布于 2026/11/09(1 天前);至今共发布 67 个版本,其中过去 12 个月发布了 67 个;首次发布于 2026/08/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。