Class CitationCache

isDestroyed

clear

• clear(): void

  Returns void

delete

• delete(key: string): boolean

  Parameters

  • key: string

  Returns boolean

destroy

• destroy(): void

  Returns void

get

• get(key: string): CitationRef[] | undefined

  Parameters

  • key: string

  Returns CitationRef[] | undefined

getCacheStats

• getCacheStats(): { newestEntry?: number; oldestEntry?: number; size: number }

  Get statistcs about the cache

  Returns { newestEntry?: number; oldestEntry?: number; size: number }

getDataForFile

• getDataForFile(sourcePath: string): Promise<CitationRef[] | undefined>

  Retrieve data for a file, updating the cache if needed

  Parameters

  • sourcePath: string

  Returns Promise<CitationRef[] | undefined>

getValidKeys

• getValidKeys(): string[]

  Returns string[]

set

• set(key: string, data: CitationRef[]): void

  Parameters

  • key: string
  • data: CitationRef[]

  Returns void

updateCache

• updateCache(sourcePath: string): Promise<void>

  Parameters

  • sourcePath: string

  Returns Promise<void>