@ atscript/ db- 客户端
HTTP 客户端 @atscript/moost-db REST终点.
Type-safe HTTP客户端,可以镜像moost-db控制器端点. 在浏览器、节点和任何运行时间中工作 fetch。每种方法将 1:1 映射到一个控制器端点—— 过滤器、排序、页码、关系加载、文本搜索和汇总都通过打入的查询控制得到支持.
在苏维埃社会主义共和国的环境下,Moost fetch 自动引导本地请求到进程内处理者, 所以相同 Client 实例在服务器和浏览器上都有效.
安装
pnpm add @atscript/db-client
快速启动
import { Client } from "@atscript/db-client";
import type { User } from "./models/user.as";
const users = new Client<typeof User>("/api/users", {
baseUrl: "https://api.example.com",
});
// Query → GET /query
const active = await users.query({ filter: { status: "active" } });
// Get one → GET /one/:id
const user = await users.one("abc-123");
// Insert → POST /
const { insertedId } = await users.insert({ name: "Alice" });
// Update → PATCH /
await users.update({ id: insertedId, role: "admin" });
// Remove → DELETE /:id
await users.remove(insertedId);
// Count → GET /query ($count)
const total = await users.count();
// Paginate → GET /pages
const page = await users.pages({ filter: { active: true } }, 1, 20);
// Metadata → GET /meta
const meta = await users.meta();
特征
- 输入的查询 ——过滤键,排序字段,
$with关系名称,主密钥会对照标记模式进行类型检查 - 完整 CRUD —— 说
query, (中文(简体) ),count, (中文(简体) ),pages, (中文(简体) ),one, (中文(简体) ),insert, (中文(简体) ),update, (中文(简体) ),replace, (中文(简体) ),remove - 合计 — 已输入
$groupBy数量和措施,包括推断结果类型 - 搜索 ——通过查询控制进行全文和矢量搜索
- 客户端验证 ——在发送前将验证书写在标注图上
- 处理错误 —— 说
ClientError有结构化验证错误 - 可配置 - 习惯
fetch,静态或同步头,基址
文档
- HTTP 客户指南 ——全面参考API实例
- HTTP API 指南 —服务器端设置
- URL 查询语法 — 筛选、排序和页形语法
许可证
麻省理工学院