Skip to content

docs: clarifying disableCache vs maxCachedContexts #1247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joker23 merged 1 commit into from
Apr 7, 2026
+17 −5
Merged

docs: clarifying disableCache vs maxCachedContexts #1247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions packages/shared/sdk-client/src/api/LDOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,16 @@ export interface LDOptions {
logger?: LDLogger;

/**
* The maximum number of locally cached contexts. The cache is used to decrease initialization
* latency and to provide fallback when the SDK cannot reach LaunchDarkly services.
* The maximum number of locally cached contexts. The cache is used to decrease initialization
* latency and to provide fallback flag values when the SDK cannot reach LaunchDarkly services.
*
* @remarks
* Setting this to `0` disables caching entirely: the SDK will not read from or
* write to the cache, and any previously cached entries will be pruned from
* local storage.
*
* To suppress cache read/writes **without** removing existing cached data, use
* {@link LDOptions.disableCache} instead.
*
* @defaultValue 5
*/
Expand Down Expand Up @@ -297,9 +305,13 @@ export interface LDOptions {
dataSystem?: LDClientDataSystemOptions;

/**
* Set to true to completely disable the persistent flag cache. When disabled,
* flags are never read from or written to local storage. This takes precedence
* over `maxCachedContexts`.
* Set to `true` to suppress all reads and writes to the persistent flag cache
* in local storage.
*
* @remarks
* Unlike setting {@link LDOptions.maxCachedContexts} to `0`,
* this does **not** remove previously cached data — existing entries are left
* intact. This takes precedence over `maxCachedContexts`.
*
* @defaultValue false
*/
Expand Down
Loading