类型安全 Graphql 查询构建器
以类型验证方式写入 Graphql 查询,并使用电池自动完成
@gqlts/ cli (英语)
@ gqlts/ 运行时间
此软件包为预留版本 学名
它已经更新, 固定了少数错误, 在最新的软件包中积极添加特性并更新依赖性和代码库
读取 快速启动引导 以本地生成客户端.
文档
- 文档网站:快速起步,实例,专题报道,以及使用指南.
- 发展指南:本地设置,发布工作流程,以及贡献命令.
- 建筑:包图,生成流,运行时流,并放出图.
- 测试:测试矩阵,更改核对表,以及全演示程序.
- API 流量:今天API行为报道所住的地方.
特征
- 类型完成
- 类型验证
- 轻松地获取类型中的所有字段
- 支持订阅( ws, 图克- ws, 可观察等)
- 已建入文件上传支持
- Graphql 客户端构建于
- 与任何客户端合作
- 在节点和浏览器中工作
- 建于Axios客户端,并用截取器导出以延伸.
- 对Axios配置的客户端操作支持,如头,超时,取消Token,中止Signal等.
- 支持批量查询
- 一致的响应格式{数据、错误、扩展}
在其中查找更多服务器客户端示例 实例重播 您将找到多个实例, 拥有不同的构建策略、 查询、 突变、 网页订阅等工具 .
示例用途
首先生成您的客户端执行
npm install -D @gqlts/cli # cli to generate the client code
npm install @gqlts/runtime graphql # runtime dependencies
npx gqlts --schema ./schema.graphql --output ./generated
对您的软件包管理器使用等效命令 : pnpm dlx gqlts, (中文(简体) ), yarn gqlts,或 bunx gqlts 所有的工作也一样.
那你就用你的客户
import { createClient, everything } from './generated';
const client = createClient();
client
.query({
countries: {
name: true,
code: true,
nestedField: {
...everything, // same as __scalar: true
},
},
})
.then(console.log);
上面的代码将获取下面的图克l查询
query {
countries {
name
code
nestedField {
scalarField1
scalarField2
}
}
}
软件包
此repo包含两个已公布的软件包:
@gqlts/cli:读取GraphQL schema并生成已输入客户端文件.@gqlts/runtime:权力在运行时生成客户端,用于查询,突变,订阅,分批,上传,以及自定义取取用器.
生成的客户端通常包含:
schema.graphql: 用于生成的图案快照.schema.ts:生成了"计划","请求","响应","守卫"等类型.index.js编号 :index.esm.js:生成通用JS和无害环境管理客户切入点.index.d.ts:生成公开的TypeScript声明.types.cjs.js编号 :types.esm.js: 压缩运行时类型映射.guards.cjs.js编号 :guards.esm.js: 生成运行时类型守护.
发展
用 Bun 从 repo 根安装 :
bun ci
常见命令 :
bun run buildall
bun run test
bun run typecheck
bun run --cwd website build
./demo-apps/build-and-test.sh
运行 ./demo-apps/build-and-test.sh 在驱动生成器、运行时间、上传、订阅、SDK或Next.js更改之前。 它运行后端演示,SDK生成,独立浏览器捆绑,Next.js dev和生产测试,以及集成测试.
详情见 发展.md, (中文(简体) ), 文件/建筑图,以及 文件/测试。 。 。 .
释放
Gqlts 使用 semantic-release 协调释放 @gqlts/runtime 财务报告和审定财务报表 @gqlts/cli。 。 。 .
develop财务报告和审定财务报表beta发布 beta 预释像x.y.z-beta.n改为npmbeta。 。 。 .alpha发布 alpha 预释像x.y.z-alpha.n改为npmalpha。 。 。 .master财务报告和审定财务报表main发布稳定的释放,如x.y.z改为npmlatest。 。 。 .- 一个语义上的放出运行计算整个回放的版本.
release:stamp将准确的版本写入根,运行时间和CLI显示.release:publish发表@gqlts/runtime先说@gqlts/cli,两者在同一版本.
有用命令 :
bun run release:verify
bun run release:dry
bun run release:local 3.5.0-beta.1 --dry-run --tag beta
正常流量 :
- 使用常规承诺.
feat, (中文(简体) ),fix, (中文(简体) ),perf, (中文(简体) ),refactor,以及revert创建释放;docs, (中文(简体) ),test, (中文(简体) ),ci, (中文(简体) ),build, (中文(简体) ),style,以及chore别. - 合并到
develop或者说beta以发布下一个β. - 合并到
alpha以发布下一个 alpha. - 合并到
master或者说main以发布下一个稳定发行.
发布工作流程首先验证,然后让语义-放出印花,构建,标记,创建"GitHub"发布,并从同一种计算版本发布两个npm包.
许可证
这是根据麻省理工学院的许可. 详情见