锡因

合同第一类型脚本框架. 类型,比例。 实时建造. 从第一天开始的人工智能.

tzin - 来自纳瓦特尔 - t一个值得珍视和爱戴的荣誉后缀. 客户端和服务器之间的契约,声明一次.

状况:稳定(1.0.x). 核心工程端到端(见 基准(三); 1.0.0 运出稳定的API,1.0.2 增加测试覆盖门,一个更大的CI 矩阵和一个公共类型清洁的表面.

npm install @carlos-tzin/tzin

或者脚手架 一个新的项目:

npx create-tzin my-app

文档

托管网站 : tzin.tzinny.com (中文(简体) )

• API 参考 - 所有出口、类型和选择
• 架构指南 - 请求管道、设计决定、内部
• 部署指南 ——多克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克
• 路线图 ——未来特色

为什么是另一个框架?

TypeScript后端的地平面很拥挤

tzin的回答是: 宣布合同一次免费得到其他一切.

import { t } from '@carlos-tzin/tzin'
import { contract, impl, createApp, listen } from '@carlos-tzin/tzin'

const getUser = contract({
  method: 'GET',
  path: '/users/:id',
  params: t.Object({ id: t.String() }),
  responses: {
    200: t.Object({ id: t.String(), name: t.String(), tags: t.Array(t.String()) }),
    404: t.Object({ error: t.String() }),
  },
})

export const getUserRoute = impl(getUser, async ({ params }) => {
  const user = await findUser(params.id)
  if (!user) throw new HttpError(404, 'user not found')
  return { status: 200, body: user }
})

const app = createApp([getUserRoute])
listen(app, 3000)

从该单项宣言:

• 处理器输入被取出, 未猜测数字 : { params } 存在是因为您声明 它; 添加 query, (中文(简体) ), body, (中文(简体) ), headers 或者说 cookies 对合同,他们似乎, 每个请求都打入并经过验证.
• 编译器执行您的回复:返回一个不匹配的形状 已声明 200 身体是一个类型错误。 丢弃 HttpError地图到他们的状态.
• OpenAPI 3.1 免费合同是JSON Schema(TypeBox),所以 generateOpenApi(routes) 不需要翻译层.

特征

核心

运行时间

实时

大赦国际

数据库

认证

工作

日志

测试

快速启动

1. 脚手架

npx create-tzin my-api
cd my-api

2. 合同的定义

// src/routes/users.ts
import { t, contract, impl } from '@carlos-tzin/tzin'

export const getUser = contract({
  method: 'GET',
  path: '/users/:id',
  params: t.Object({ id: t.String() }),
  responses: {
    200: t.Object({ id: t.String(), name: t.String() }),
    404: t.Object({ error: t.String() }),
  },
})

export const getUserRoute = impl(getUser, async ({ params }) => {
  return { status: 200, body: { id: params.id, name: 'Ada' } }
})

3. 创建应用程序

// src/app.ts
import { createApp } from '@carlos-tzin/tzin'
import { getUserRoute } from './routes/users.js'

export const app = createApp([getUserRoute], {
  openapi: true,
  mcp: true,
  meta: { title: 'My API', version: '1.0.0' },
})

4. 运行

npm run dev    # tzin dev  -> dev server at http://localhost:3000
npm run build  # tzin build -> production build

这个 tzin 带包裹的二进制飞船,所以这些脚本在之后工作 npm install没有 本地安装, 通过 npm exec 运行 :

npx --package @carlos-tzin/tzin tzin dev

国 际

tzin dev [--port N]                                # dev server with hot reload
tzin build                                         # build for production
tzin deploy --target node|workers [--pack] [--docker <tag> [--push]]  # deploy
tzin generate route <name>                         # scaffold a route
tzin generate middleware <name>                    # scaffold middleware
tzin generate test <name>                          # scaffold a test

基准

100个有不同计划的最终点,由 tsc --extendedDiagnostics数字 :

天津生长 严格线性 (~130个类型/端点.

运行时间吞吐量

实例

设计原则

• 合同第一,统一登记. 一条路由是数据(contract({...})链接 在建造链。 推论成本保持每个终点的O(1).
• JSON斯克马本地人. TypeBox schemas 二相为OpenAPI,零转换.
• 网络标准运行时间. Request 内, Response 退出;适配器保持瘦弱.
• 解开者战胜魔法. 交易员得到的正是合同申报的内容.
• 错误是控制流 . 丢入打出的错误; 响应联盟已经知道 .
• Light DI 不举行仪式. provide(key, value) 在应用级种子类型中 每个请求的上下文中的单通数——处理者 ctx.require(db)。 。 。 .

发展

npm install
npm test          # vitest — runtime + end-to-end client + type assertions
npm run typecheck # strict tsc across src/test/bench fixtures

许可证

麻省理工学院——见 自由主义。 。 。 .