$withAuth() — drizzle-orm Function Reference

Architecture documentation for the $withAuth() function in driver.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders calls 1

Entity Profile

DrizzleORM→ QueryBuilders→ $withAuth() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  2db4716b_9688_9922_c6ec_1ea6772d014f["$withAuth()"]
  b6b337f5_bcc2_5e22_edc8_a716053cc396["NeonHttpDatabase"]
  2db4716b_9688_9922_c6ec_1ea6772d014f -->|defined in| b6b337f5_bcc2_5e22_edc8_a716053cc396
  8c4a41bf_c14a_8a42_f07e_9d1dd21acbf9["wrap()"]
  2db4716b_9688_9922_c6ec_1ea6772d014f -->|calls| 8c4a41bf_c14a_8a42_f07e_9d1dd21acbf9
  style 2db4716b_9688_9922_c6ec_1ea6772d014f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/neon-http/driver.ts lines 85–112

	$withAuth(
		token: Exclude<HTTPQueryOptions<true, true>['authToken'], undefined>,
	): Omit<
		this,
		Exclude<
			keyof this,
			| '$count'
			| 'delete'
			| 'select'
			| 'selectDistinct'
			| 'selectDistinctOn'
			| 'update'
			| 'insert'
			| 'with'
			| 'query'
			| 'execute'
			| 'refreshMaterializedView'
		>
	> {
		this.authToken = token;

		return wrap(this, token, (target, p, res) => {
			if (p === 'with') {
				return wrap(res, token, (_, __, res) => res);
			}
			return res;
		});
	}