drizzle-orm Architecture Docs
Home / Type/ PgEnum Type — drizzle-orm Architecture

PgEnum Type — drizzle-orm Architecture

Architecture documentation for the PgEnum type/interface in enum.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  5e5d4a3d_ebb4_6527_c58d_94da6378ee73["PgEnum"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3["enum.ts"]
  5e5d4a3d_ebb4_6527_c58d_94da6378ee73 -->|defined in| cc1fbfaa_1553_bc17_cd31_5fefac6896d3
  style 5e5d4a3d_ebb4_6527_c58d_94da6378ee73 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 86–96

export interface PgEnum<TValues extends [string, ...string[]]> {
	(): PgEnumColumnBuilderInitial<'', TValues>;
	<TName extends string>(name: TName): PgEnumColumnBuilderInitial<TName, TValues>;
	<TName extends string>(name?: TName): PgEnumColumnBuilderInitial<TName, TValues>;

	readonly enumName: string;
	readonly enumValues: TValues;
	readonly schema: string | undefined;
	/** @internal */
	[isPgEnumSym]: true;
}

Defined In

Source

Frequently Asked Questions

What is the PgEnum type?
PgEnum is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/columns/enum.ts.
Where is PgEnum defined?
PgEnum is defined in drizzle-orm/src/pg-core/columns/enum.ts at line 86.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free