drizzle-orm Architecture Docs
Home / Class/ Param Class — drizzle-orm Architecture

Param Class — drizzle-orm Architecture

Architecture documentation for the Param class in sql.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  d61f487a_d2dd_edf1_cf65_be62c407b136["Param"]
  99347ab2_b1a1_faf4_e37c_7643e4b2eb8a["sql.ts"]
  d61f487a_d2dd_edf1_cf65_be62c407b136 -->|defined in| 99347ab2_b1a1_faf4_e37c_7643e4b2eb8a
  04780eeb_9258_e6b4_4cfb_ca1f828411fb["constructor()"]
  d61f487a_d2dd_edf1_cf65_be62c407b136 -->|method| 04780eeb_9258_e6b4_4cfb_ca1f828411fb
  5f137afa_8809_b4de_5638_b96ccacf5967["getSQL()"]
  d61f487a_d2dd_edf1_cf65_be62c407b136 -->|method| 5f137afa_8809_b4de_5638_b96ccacf5967

Relationship Graph

Source Code

drizzle-orm/src/sql/sql.ts lines 433–450

export class Param<TDataType = unknown, TDriverParamType = TDataType> implements SQLWrapper {
	static readonly [entityKind]: string = 'Param';

	protected brand!: 'BoundParamValue';

	/**
	 * @param value - Parameter value
	 * @param encoder - Encoder to convert the value to a driver parameter
	 */
	constructor(
		readonly value: TDataType,
		readonly encoder: DriverValueEncoder<TDataType, TDriverParamType> = noopEncoder,
	) {}

	getSQL(): SQL<unknown> {
		return new SQL([this]);
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the Param class?
Param is a class in the drizzle-orm codebase, defined in drizzle-orm/src/sql/sql.ts.
Where is Param defined?
Param is defined in drizzle-orm/src/sql/sql.ts at line 433.

Analyze Your Own Codebase

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

Try Supermodel Free