UserSchemaInfo

Configuration for extending the user record type with custom metadata validators and migration sequences.

interface UserSchemaInfo {}

Example

import { T } from "@tldraw/validate";

const userSchema: UserSchemaInfo = {
  meta: {
    isAdmin: T.boolean,
    department: T.string,
  },
};

Properties

Validators for custom metadata fields on user records. Each field is treated as optional — user records without these fields remain valid, but when present, values are validated against the provided validators.

meta?: Record<string, T.Validatable<any>>;

Additional migration sequences for evolving custom user data over time.

migrations?: readonly MigrationSequence[];