isPgEnum() — drizzle-orm Function Reference

Architecture documentation for the isPgEnum() function in enum.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ isPgEnum() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  788442cd_e093_428e_e7b7_cc7be594fde3["isPgEnum()"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3["enum.ts"]
  788442cd_e093_428e_e7b7_cc7be594fde3 -->|defined in| cc1fbfaa_1553_bc17_cd31_5fefac6896d3
  style 788442cd_e093_428e_e7b7_cc7be594fde3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 98–100

export function isPgEnum(obj: unknown): obj is PgEnum<[string, ...string[]]> {
	return !!obj && typeof obj === 'function' && isPgEnumSym in obj && obj[isPgEnumSym] === true;
}