isWithEnum() — drizzle-orm Function Reference

Architecture documentation for the isWithEnum() function in utils.ts from the drizzle-orm codebase.

Function typescript ValidationAdapters SchemaRefinement called by 1

Entity Profile

ValidationAdapters→ SchemaRefinement→ isWithEnum() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  cf473206_de02_b9d4_6152_24ac8addfcfa["isWithEnum()"]
  0dcff89a_a60f_bf80_037e_d24dd39456e3["utils.ts"]
  cf473206_de02_b9d4_6152_24ac8addfcfa -->|defined in| 0dcff89a_a60f_bf80_037e_d24dd39456e3
  06e21ad5_4a79_38ca_ddc3_d0ed3cb1ab5c["columnToSchema()"]
  06e21ad5_4a79_38ca_ddc3_d0ed3cb1ab5c -->|calls| cf473206_de02_b9d4_6152_24ac8addfcfa
  style cf473206_de02_b9d4_6152_24ac8addfcfa fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-typebox/src/utils.ts lines 10–12

export function isWithEnum(column: Column): column is typeof column & { enumValues: [string, ...string[]] } {
	return 'enumValues' in column && Array.isArray(column.enumValues) && column.enumValues.length > 0;
}