file-entry-cache

constructor

constructor(options?: FileEntryCacheOptions);

• Create a new FileEntryCache instance

  Parameter options

  The options for the FileEntryCache (all properties are optional with defaults)

property cache

cache: FlatCache;

• Get the cache

  Returns

  {FlatCache} The cache

property cwd

cwd: string;

• Get the current working directory

  Returns

  {string} The current working directory (default: process.cwd())

property hashAlgorithm

hashAlgorithm: string;

• Get the hash algorithm

  Returns

  {string} The hash algorithm (default: 'md5')

property logger

logger: ILogger;

• Get the logger

  Returns

  {ILogger | undefined} The logger instance

property restrictAccessToCwd

restrictAccessToCwd: boolean;

• Get whether to restrict paths to cwd boundaries

  Returns

  {boolean} Whether strict path checking is enabled (default: true)

property useAbsolutePathAsKey

useAbsolutePathAsKey: boolean;

• Get whether to use absolute path as cache key

  Returns

  {boolean} Whether cache keys use absolute paths (default: false)

property useCheckSum

useCheckSum: boolean;

• Use the hash to check if the file has changed

  Returns

  {boolean} if the hash is used to check if the file has changed (default: false)

property useModifiedTime

useModifiedTime: boolean;

• Get whether to use modified time for change detection

  Returns

  {boolean} Whether modified time (mtime) is used for change detection (default: true)

method analyzeFiles

analyzeFiles: (files: string[]) => AnalyzedFiles;

• Analyze the files analyzeFiles

  Parameter files

  The files to analyze

  Returns

  {AnalyzedFiles} The analysis of the files

method createFileKey

createFileKey: (filePath: string) => string;

• Create the key for the file path used for caching. createFileKey

  Parameter filePath

  {String}

method deleteCacheFile

deleteCacheFile: () => boolean;

• Delete the cache file from the disk deleteCacheFile {boolean} true if the file was deleted, false otherwise

method destroy

destroy: () => void;

• Remove the cache from the file and clear the memory cache destroy

method getAbsolutePath

getAbsolutePath: (filePath: string) => string;

• Get the Absolute Path. If it is already absolute it will return the path as is. When restrictAccessToCwd is enabled, ensures the resolved path stays within cwd boundaries. getAbsolutePath

  Parameter filePath

  The file path to get the absolute path for

  Returns

  {string}

  Throws

  {Error} When restrictAccessToCwd is true and path would resolve outside cwd

method getAbsolutePathWithCwd

getAbsolutePathWithCwd: (filePath: string, cwd: string) => string;

• Get the Absolute Path with a custom working directory. If it is already absolute it will return the path as is. When restrictAccessToCwd is enabled, ensures the resolved path stays within the provided cwd boundaries. getAbsolutePathWithCwd

  Parameter filePath

  The file path to get the absolute path for

  Parameter cwd

  The custom working directory to resolve relative paths from

  Returns

  {string}

  Throws

  {Error} When restrictAccessToCwd is true and path would resolve outside the provided cwd

method getFileDescriptor

getFileDescriptor: (
    filePath: string,
    options?: GetFileDescriptorOptions
) => FileDescriptor;

• Get the file descriptor for the file path getFileDescriptor

  Parameter filePath

  The file path to get the file descriptor for

  Parameter options

  The options for getting the file descriptor

  Returns

  The file descriptor

method getFileDescriptorsByPath

getFileDescriptorsByPath: (filePath: string) => FileDescriptor[];

• Get the file descriptors by path prefix getFileDescriptorsByPath

  Parameter filePath

  the path prefix to match

  Returns

  {FileDescriptor[]} The file descriptors

method getHash

getHash: (buffer: Buffer) => string;

• Given a buffer, calculate md5 hash of its content. getHash

  Parameter buffer

  buffer to calculate hash on {String} content hash digest

method getUpdatedFiles

getUpdatedFiles: (files: string[]) => string[];

• Get the updated files getUpdatedFiles

  Parameter files

  The files to get the updated files for

  Returns

  {string[]} The updated files

method hasFileChanged

hasFileChanged: (filePath: string) => boolean;

• Check if the file has changed hasFileChanged

  Parameter filePath

  The file path to check

  Returns

  {boolean} if the file has changed, false otherwise

method isRelativePath

isRelativePath: (filePath: string) => boolean;

• Check if the file path is a relative path isRelativePath

  Parameter filePath

  The file path to check

  Returns

  {boolean} if the file path is a relative path, false otherwise

method normalizeEntries

normalizeEntries: (files?: string[]) => FileDescriptor[];

• Get the file descriptors for the files normalizeEntries

  Parameter files

  ?: string[] - The files to get the file descriptors for

  Returns

  The file descriptors

method reconcile

reconcile: () => void;

• Reconcile the cache reconcile

method removeEntry

removeEntry: (filePath: string) => void;

• Remove and Entry From the Cache removeEntry

  Parameter filePath

  The file path to remove from the cache

method renameCacheKeys

renameCacheKeys: (oldPath: string, newPath: string) => void;

• Rename cache keys that start with a given path prefix. renameCacheKeys

  Parameter oldPath

  The old path prefix to rename

  Parameter newPath

  The new path prefix to rename to

property create

static create: (
    cacheId: string,
    cacheDirectory?: string,
    options?: CreateOptions
) => FileEntryCache;

property createFromFile

static createFromFile: (
    filePath: string,
    options?: CreateOptions
) => FileEntryCache;