Models

Models

Models are defined with defineModel() and field builders from t.

Example

import type { InferInput, InferModel } from 'jsorm';
import { defineModel, t } from 'jsorm';

const User = defineModel('users', {
  id: t.number().primary(),
  name: t.string(),
  email: t.string().optional(),
  active: t.boolean().default(true),
  createdAt: t.date(),
});

type UserRecord = InferModel<typeof User>;
type UserInput = InferInput<typeof User>;

Supported field builders

• t.string()
• t.number()
• t.boolean()
• t.date()
• relation builders like t.belongsTo() and t.hasMany()

Common field modifiers

• .optional()
• .nullable()
• .primary()
• .default(value)
• .unique()
• .index()

Best practices

1. Keep table names stable and explicit.
2. Put relation definitions next to related foreign key intent.
3. Prefer inferred InferModel and InferInput instead of manual interfaces.