arktype

安装依赖

npm

yarn

pnpm

bun

npm i arktype

yarn add arktype

pnpm add arktype

bun add arktype

选择 schema

定义从数据库查询出的数据形状——可用于验证 API 响应。

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createSelectSchema } from 'drizzle-orm/arktype';
import { ArkErrors } from "arktype";

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: integer().notNull()
});

const userSelectSchema = createSelectSchema(users);

const rows = await db.select({ id: users.id, name: users.name }).from(users).limit(1);
const parsed: ArkErrors | { id: number; name: string; age: number } = userSelectSchema(rows[0]); // 错误：上面的查询未返回 `age`

const rows = await db.select().from(users).limit(1);
const parsed: ArkErrors | { id: number; name: string; age: number } = userSelectSchema(rows[0]); // 将成功解析

也支持视图。

import { sqliteView } from 'drizzle-orm/sqlite-core';
import { gt } from 'drizzle-orm';
import { createSelectSchema } from 'drizzle-orm/arktype';
import { ArkErrors } from "arktype";

const usersView = sqliteView('users_view').as((qb) => qb.select().from(users).where(gt(users.age, 18)));
const usersViewSchema = createSelectSchema(usersView);
const parsed: ArkErrors | { id: number; name: string; age: number } = usersViewSchema(...);

插入 schema

定义要插入到数据库中的数据形状——可用于验证 API 请求。

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createInsertSchema } from 'drizzle-orm/arktype';
import { ArkErrors } from "arktype";

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: integer().notNull()
});

const userInsertSchema = createInsertSchema(users);

const user = { name: 'John' };
const parsed: ArkErrors | { name: string, age: number } = userInsertSchema(user); // 错误：未定义 `age`

const user = { name: 'Jane', age: 30 };
const parsed: ArkErrors | { name: string, age: number } = userInsertSchema(user); // 将成功解析

if (parsed instanceof ArkErrors) {
  console.error(parsed.summary);
  process.exit(1);
}

await db.insert(users).values(parsed);

更新 schema

定义要在数据库中更新的数据形状——可用于验证 API 请求。

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createUpdateSchema } from 'drizzle-orm/arktype';
import { ArkErrors } from 'arktype';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: integer().notNull()
});

const userUpdateSchema = createUpdateSchema(users);

const user = { age: 35 };
const parsed: ArkErrors | { name?: string | undefined, age?: number | undefined } = userUpdateSchema(user); // 将成功解析

if (parsed instanceof ArkErrors) {
  console.error(parsed.summary);
  process.exit(1);
}

await db.update(users).set(parsed).where(eq(users.name, 'Jane'));

细化

每个 create schema 函数都接受一个额外的可选参数，你可以用它来扩展、修改或完全覆盖某个字段的 schema。定义一个回调函数会进行扩展或修改，而提供一个 arktype schema 则会覆盖它。

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createSelectSchema } from 'drizzle-orm/arktype';
import { ArkErrors, type } from 'arktype';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  bio: text(),
  preferences: text({ mode: 'json' })
});

const userSelectSchema = createSelectSchema(users, {
  name: (schema) => schema.atMostLength(20), // 扩展 schema
  bio: (schema) => type.string.atMostLength(2000), // 在变为可空/可选之前扩展 schema
  preferences: type({ theme: 'string' }) // 覆盖该字段，包括其可空性
});

const parsed: ArkErrors | {
  id: number;
  name: string,
  bio: string | null;
  preferences: {
    theme: string;
  };
} = userSelectSchema(...);

数据类型参考

sqlite.integer({ mode: 'boolean' });

// Schema
type.boolean;

sqlite.integer({ mode: 'timestamp' });
sqlite.integer({ mode: 'timestamp_ms' });

// Schema
type.Date;

sqlite.numeric();
sqlite.text({ mode: 'text' });

// Schema
type.string;

sqlite.numeric({ mode: 'number' });

// Schema
type.number.atLeast(-9_007_199_254_740_991).atMost(9_007_199_254_740_991); // Javascript 最小和最大安全整数

sqlite.numeric({ mode: 'bigint' });

// Schema
type.bigint.narrow(
  (value, ctx) => value < -9_223_372_036_854_775_808n ? ctx.mustBe('greater than') : value > 9_223_372_036_854_775_807n ? ctx.mustBe('less than') : true
); // 64 位整数下限和上限

sqlite.text({ mode: 'text', length: ... });

// Schema
type.string.atMostLength(length);

sqlite.text({ mode: 'text', enum: ... });

// Schema
type.enumerated(...enum);

sqlite.real();

// Schema
type.number.atLeast(-140_737_488_355_328).atMost(140_737_488_355_327); // 48 位整数下限和上限

sqlite.integer({ mode: 'number' });

// Schema
type.keywords.number.integer.atLeast(-9_007_199_254_740_991).atMost(9_007_199_254_740_991); // Javascript 最小和最大安全整数

sqlite.blob({ mode: 'bigint' });

// Schema
type.bigint.narrow(
  (value, ctx) => value < -9_223_372_036_854_775_808n ? ctx.mustBe('greater than') : value > 9_223_372_036_854_775_807n ? ctx.mustBe('less than') : true
); // 64 位整数下限和上限

sqlite.blob({ mode: 'json' });
sqlite.text({ mode: 'json' });

// Schema
type('string | number | boolean | null').or(type('unknown.any[] | Record<string, unknown.any>'));

sqlite.blob({ mode: 'buffer' });

// Schema
type.instanceOf(Buffer);