@ng-doc/builder / TypeAlias

CacheStrategy

Generic types:TData TCache

Cache strategy skip strategy will skip the builder if cache is valid restore strategy will restore the data from cache and return the result

Properties

NameTypeDescription
files
(() => string[]) | undefined

Should return file paths that should be checked for changes

getData
(() => TData) | undefined

Function to save custom data to cache

id
string

Unique id for cache

onCacheLoad
((data: TData) => void) | undefined

Callback that will be called when cache is loaded and valid

Presentation

type CacheStrategy = {
  /**
   * Unique id for cache
   */
  id: string;
  /**
   * Should return file paths that should be checked for changes
   */
  files?: () => string[];
  /**
   * Function to save custom data to cache
   */
  getData?: () => TData;
  /**
   * Callback that will be called when cache is loaded and valid
   */
  onCacheLoad?: (data: TData) => void;
} & (
  | {
      action: "skip";
    }
  | {
      action: "restore";
      toCache: (result: TCache) => string;
      fromCache: (result: string) => TCache;
    }
);