API Reference / @evolu/common / Evolu/Internal / ValidEvoluSchema

Variable: ValidEvoluSchema

const ValidEvoluSchema: BrandType<RecordType<"Brand", string & Brand<"Base64Url"> & Brand<"MaxLength42"> & Brand<"MinLength1"> & Brand<"TableName">, string, BrandWithoutRefineError<"TableName", 
  | StringError
  | MinLengthError<1>
  | RegexError<"Base64Url">
  | MaxLengthError<42>>, string & Brand<"Base64Url"> & Brand<"MaxLength42"> & Brand<"MinLength1">, never, ObjectWithRecordType<{
  id: Type<"EvoluType", AnyType, AnyType, EvoluTypeError, AnyType, EvoluTypeError>;
}, "Brand", string & Brand<"Base64Url"> & Brand<"MaxLength42"> & Brand<"MinLength1"> & Brand<"ColumnName">, string, BrandWithoutRefineError<"ColumnName", 
  | StringError
  | MinLengthError<1>
  | RegexError<"Base64Url">
  | MaxLengthError<42>>, string & Brand<"Base64Url"> & Brand<"MaxLength42"> & Brand<"MinLength1">, never, Type<"Unknown", unknown, unknown, never, unknown, never>>>, "ValidEvoluSchema", ValidEvoluSchemaError, 
  | RecordError<BrandWithoutRefineError<"TableName", 
  | StringError
  | MinLengthError<1>
  | RegexError<"Base64Url">
  | MaxLengthError<42>>, ObjectWithRecordError<{
  id: EvoluTypeError;
}, BrandWithoutRefineError<"ColumnName", 
  | StringError
  | MinLengthError<1>
  | RegexError<"Base64Url">
  | MaxLengthError<42>>, never>>
  | RecordError<never, ObjectWithRecordError<{
  id: EvoluTypeError;
}, never, never>>>;

Defined in: packages/common/src/Evolu/Schema.ts:138

Valid EvoluSchema.

Table and column names must be Base64Url strings.
Each table must include an id column of type Id.
Default column names (createdAt, updatedAt, isDeleted) are not allowed.