typebox

安装依赖

npm

yarn

pnpm

bun

npm i drizzle-orm@rc typebox

yarn add drizzle-orm@rc typebox

pnpm add drizzle-orm@rc typebox

bun add drizzle-orm@rc typebox

允许你根据 Drizzle ORM 模式生成 typebox schema

特性

为表和枚举创建 select schema。
为表创建 insert 和 update schema。
支持的方言：CockroachDB。

用法

import { int4, cockroachTable, text, timestamp } from 'drizzle-orm/cockroach-core';
import { createInsertSchema, createSelectSchema, createUpdateSchema } from 'drizzle-orm/typebox';
import { Type } from 'typebox';
import { Value } from 'typebox/value';

const users = cockroachTable('users', {
	id: int4().primaryKey().generatedAlwaysAsIdentity(),
	name: text().notNull(),
	email: text().notNull(),
	role: text({ enum: ['admin', 'user'] }).notNull(),
	createdAt: timestamp('created_at').notNull().defaultNow(),
});

// 用于插入用户的 schema - 可用于验证 API 请求
const insertUserSchema = createInsertSchema(users);

// 用于更新用户的 schema - 可用于验证 API 请求
const updateUserSchema = createUpdateSchema(users);

// 用于选择用户的 schema - 可用于验证 API 响应
const selectUserSchema = createSelectSchema(users);

// 覆盖字段
const insertUserSchema = createInsertSchema(users, {
	role: Type.String(),
});

// 细化字段 - 如果你想在最终 schema 中字段变为 nullable/optional 之前先修改它们，这会很有用
const insertUserSchema = createInsertSchema(users, {
	id: (schema) => Type.Number({ ...schema, minimum: 0 }),
	role: Type.String(),
});

// 用法

const isUserValid: boolean = Value.Check(insertUserSchema, {
	name: 'John Doe',
	email: 'johndoe@test.com',
	role: 'admin',
});