isDrizzleObjName() — drizzle-orm Function Reference

Architecture documentation for the isDrizzleObjName() function in options.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers called by 1

Entity Profile

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

Dependency Diagram

graph TD
  d8235cf8_b61d_834b_113c_b39fe207c3d4["isDrizzleObjName()"]
  73e2aa44_a4c6_8ec0_4c1d_1b146021dedc["options.ts"]
  d8235cf8_b61d_834b_113c_b39fe207c3d4 -->|defined in| 73e2aa44_a4c6_8ec0_4c1d_1b146021dedc
  a580025e_b3a5_ddc6_91a8_9e031d9d7cf0["isDrizzleObj()"]
  a580025e_b3a5_ddc6_91a8_9e031d9d7cf0 -->|calls| d8235cf8_b61d_834b_113c_b39fe207c3d4
  style d8235cf8_b61d_834b_113c_b39fe207c3d4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

eslint-plugin-drizzle/src/utils/options.ts lines 7–21

const isDrizzleObjName = (name: string, drizzleObjectName: string[] | string) => {
	if (typeof drizzleObjectName === 'string') {
		return name === drizzleObjectName;
	}

	if (Array.isArray(drizzleObjectName)) {
		if (drizzleObjectName.length === 0) {
			return true;
		}

		return drizzleObjectName.includes(name);
	}

	return false;
};