Skip to main content
Version: 5.2

FileCacheAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

  • new FileCacheAdapter(options: { cacheDir: string }, baseDir: string, pretty?: boolean): FileCacheAdapter
  • Parameters

    • options: { cacheDir: string }
    • baseDir: string
    • pretty: boolean = false

    Returns FileCacheAdapter

Methods

clear

  • clear(): Promise<void>
  • Clears all items stored in the cache.


    Returns Promise<void>

get

  • get(name: string): Promise<any>
  • Gets the items under name key from the cache.


    Parameters

    • name: string

    Returns Promise<any>

remove

  • remove(name: string): Promise<void>
  • Removes the item from cache.


    Parameters

    • name: string

    Returns Promise<void>

set

  • set(name: string, data: any, origin: string): Promise<void>
  • Sets the item to the cache. origin is used for cache invalidation and should reflect the change in data.


    Parameters

    • name: string
    • data: any
    • origin: string

    Returns Promise<void>