Skip to Content

schemaOf

Hàm dựng schema zod cho body tạo và sửa từ các cột của một bảng, để handler không phải khai báo lại từng trường.

Cách dùng

app/orders/post.ts
import { z } from "@hono/zod-openapi"; import { schemaOf } from "app/db"; import { orders } from "./orders.table"; import { createOrder } from "./repository"; const S = schemaOf(orders); export const schema = { body: S.insert.pick({ customerName: true, total: true }).extend({ total: z.number().positive() }), }; export default (c, { user, body }) => createOrder(user, body);

Chữ ký

app/db.ts
function schemaOf(table: SQLiteTable): { insert: z.ZodObject; update: z.ZodObject };

Tham số

  • table: một bảng khai báo bằng sqliteTable trong *.table.ts.

Trả về

Hai object zod thường, dùng được .pick, .omit, .extend, .partial:

  • insert: mọi cột trừ khoá chính số tự tăng. Cột có giá trị mặc định hoặc cho phép null thành không bắt buộc.
  • update: mọi cột, cột nào cũng không bắt buộc.

Cột đổi sang zod như sau:

  • text → z.string(); text(…, { enum }) → z.enum(…)
  • integer → z.number().int(); real → z.number()
  • integer({ mode: "boolean" }) → z.boolean()
  • cột kiểu ngày → z.coerce.date()
  • cột cho phép null → thêm .nullable()

Ví dụ

Body sửa chỉ nhận vài trường:

app/orders/[id:int]/patch.ts
import { schemaOf } from "app/db"; import { orders } from "../orders.table"; export const schema = { body: schemaOf(orders).update.pick({ customerName: true, note: true }) };

Chỉ pick những trường client được gửi. Body tạo không được mang status, createdBy, tổng tiền hay giá: repository tự đặt các giá trị đó.

Bước tiếp theo

Cập nhật