BuildCacheOptions

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:112

Options of buildCache. The store can be provided in three ways: a pre-built cache, pre-built stores, or declarative store configuration. When several are given, cache takes precedence over stores, which takes precedence over store; the others are ignored. An empty stores array counts as absent. When none is supplied an in-memory store is used.

Example

Redis-backed cache

buildCache({
  store: { type: 'redis', url: redisUrl },
  ttl: 30_000,
});

Properties

cache?

optional cache?: Cache

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:114

Escape hatch: a fully constructed cache-manager instance.

---

nonBlocking?

optional nonBlocking?: boolean

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:122

Forwarded to cache-manager; optimizes behavior across multiple stores.

---

store?

optional store?: CacheStoreConfig | CacheStoreConfig[]

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:118

Declarative store configuration — a single store or a tiered list.

---

stores?

optional stores?: Keyv<any>[]

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:116

Escape hatch: pre-built Keyv stores (tiered, highest priority first).

---

ttl?

optional ttl?: number

Defined in: packages/pipeline-cache/src/interfaces/cache-options.interface.ts:120

Default time-to-live (milliseconds) applied across stores and handlers.