Interface CacheSettings

interface CacheSettings {
    cacheFormat?: CacheFormat;
    cacheLocation?: string;
    cacheStrategy?: CacheStrategy;
    useCache?: boolean;
}

Properties

cacheFormat? cacheLocation? cacheStrategy? useCache?

Properties

Optional cacheFormat

cacheFormat?: CacheFormat

Format of the cache file.

  • legacy - use absolute paths in the cache file
  • universal - use a sharable format.

Default

'legacy'

Optional cacheLocation

cacheLocation?: string

Path to the cache location. Can be a file or a directory. If none specified .cspellcache will be used. Relative paths are relative to the config file in which it is defined.

A prefix of ${cwd} is replaced with the current working directory.

Optional cacheStrategy

cacheStrategy?: CacheStrategy

Strategy to use for detecting changed files, default: metadata

Default

'metadata'

Optional useCache

useCache?: boolean

Store the results of processed files in order to only operate on the changed ones.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc