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

CacheConfig Type — drizzle-orm Architecture

Architecture documentation for the CacheConfig type/interface in types.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  7d785cd6_1941_2ba0_edf2_53d4ae45aa91["CacheConfig"]
  ce81fb60_5bfe_1801_89bb_8ae88028a0a7["types.ts"]
  7d785cd6_1941_2ba0_edf2_53d4ae45aa91 -->|defined in| ce81fb60_5bfe_1801_89bb_8ae88028a0a7
  style 7d785cd6_1941_2ba0_edf2_53d4ae45aa91 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/cache/core/types.ts lines 1–27

export type CacheConfig = {
	/**
	 * expire time, in seconds (a positive integer)
	 */
	ex?: number;
	/**
	 * expire time, in milliseconds (a positive integer).
	 */
	px?: number;
	/**
	 * Unix time at which the key will expire, in seconds (a positive integer).
	 */
	exat?: number;
	/**
	 * Unix time at which the key will expire, in milliseconds (a positive integer)
	 */
	pxat?: number;
	/**
	 * Retain the time to live associated with the key.
	 */
	keepTtl?: boolean;
	/**
	 * Set an expiration (TTL or time to live) on one or more fields of a given hash key.
	 * Used for HEXPIRE command
	 */
	hexOptions?: 'NX' | 'nx' | 'XX' | 'xx' | 'GT' | 'gt' | 'LT' | 'lt';
};

Defined In

Source

Frequently Asked Questions

What is the CacheConfig type?
CacheConfig is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/cache/core/types.ts.
Where is CacheConfig defined?
CacheConfig is defined in drizzle-orm/src/cache/core/types.ts at line 1.

Analyze Your Own Codebase

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

Try Supermodel Free