@salesforce/lds-worker-api 1.245.0 → 1.247.0

package/dist/standalone/es/types/cachePurging.d.ts

@@ -26,13 +26,25 @@ export type ProgressUpdateCallback = (progess: EvictProgress) => void;
  * @param recordIds record id array
  * @onProgressUpdate call back to report evict progress
  *
- * @returns a function to cancel the eviction
+ * @returns evictId, call cancelEviction with it to abort the eviction.
  *
  * The record will not be purged if the record has draft.
  */
 export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): string;
+/**
+ * Purging the db entries which passed expired time by specified days
+ * from durable store.
+ * @param expiredByDays
+ * @param onProgressUpdate
+ *
+ * @returns an evictId, call cancelEviction with it to abort the eviction.
+ *
+ * Important: records with draft, objectInfo entries will not be purged even expired by the specified days.
+ */
+export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): string;
 /**
  * Cancel the eviction by specified id.
+ * Signal to cancel the eviction if the eviction is going on.
  * @param evictionId
  */
 export declare function cancelEviction(evictionId: string): void;

package/dist/standalone/es/types/main.d.ts

@@ -5,5 +5,5 @@ import { draftQueue, draftManager } from './draftQueueImplementation';
 import { setUiApiRecordTTL, setMetadataTTL } from './ttl';
 import { registerReportObserver } from '@salesforce/lds-runtime-mobile';
 import { createPrimingSession } from './primingApi';
-import { evictCacheRecordsByIds, cancelEviction } from './cachePurging';
-export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, cancelEviction, };
+import { evictCacheRecordsByIds, evictExpiredCacheEntries, cancelEviction } from './cachePurging';
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, cancelEviction, };