Home / Type/ PgEnumObject Type — drizzle-orm Architecture

PgEnumObject Type — drizzle-orm Architecture

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

Entity Profile

Dependency Diagram

graph TD
  0b25c336_df4c_0b09_7e30_8a3450cb0f02["PgEnumObject"]
  1a573fd5_6bcb_e77c_2a41_4eb7a1bda69d["enum.ts"]
  0b25c336_df4c_0b09_7e30_8a3450cb0f02 -->|defined in| 1a573fd5_6bcb_e77c_2a41_4eb7a1bda69d
  style 0b25c336_df4c_0b09_7e30_8a3450cb0f02 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 19–29

export interface PgEnumObject<TValues extends object> {
	(): PgEnumObjectColumnBuilderInitial<'', TValues>;
	<TName extends string>(name: TName): PgEnumObjectColumnBuilderInitial<TName, TValues>;
	<TName extends string>(name?: TName): PgEnumObjectColumnBuilderInitial<TName, TValues>;

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

Frequently Asked Questions

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

Analyze Your Own Codebase

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

Try Supermodel Free