API reference

FeatureFlarePersistentSnapshot

Serialized snapshot stored by persistent cache adapters.

Current section

Component and config reference

Use these pages when you need props, defaults, and provider behavior details.

FeatureFlarePersistentSnapshot

Serialized flag cache shape stored by persistent cache adapters.

More on this: see FeatureFlarePersistentCacheAdapter for the adapter contract that loads and saves this object.

export type FeatureFlarePersistentSnapshot = {
  revision?: number;
  killSwitches?: string[];
  flags: Record<
    string,
    {
      value: boolean;
      updatedAt: number;
      staleAt: number;
      expiresAt: number;
      source?: FeatureFlareCacheSource;
      revision?: number;
    }
  >;
};

Fields

revision?: number

Snapshot revision for ordering writes and invalidation.

killSwitches?: string[]

Persisted kill-switch list applied before normal flag evaluation.

flags: Record<string, { ... }>

Each flag entry stores the boolean value plus cache timing metadata used for fresh, stale, and expired reads.

Related docs

FeatureFlarePersistentCacheAdapter for the adapter API that stores this snapshot.
FeatureFlareReactConfig for the config field that accepts persistent cache adapters.