Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FSCache

A file system cache (with no lifecycle management) based on npm's cacache.

Make sure to close() after use to remove the cache files.

see

FSCache.LRUBinning for a pseudo-LRU Binnning lifecycle-managed file system cache.

Hierarchy

  • FSCache

Implements

Index

Classes

Constructors

Properties

Methods

Constructors

constructor

  • new FSCache(cacheDir: string | Promise<string>): FSCache

  • Parameters

    • cacheDir: string | Promise<string>

    Returns FSCache

Properties

cacheDir

cacheDir: string | Promise<string>

cacheType

cacheType: "async" = "async"

count

count: number = 0

dataSize

dataSize: number = 0

Methods

close

  • close(): Promise<void>

delete

  • delete(key: string | Buffer): Promise<void>

  • Parameters

    • key: string | Buffer

    Returns Promise<void>

get

  • get(key: string | Buffer): Promise<undefined | Buffer>

  • Parameters

    • key: string | Buffer

    Returns Promise<undefined | Buffer>

set

  • set(key: string | Buffer, value: Buffer): Promise<void>

  • Parameters

    • key: string | Buffer
    • value: Buffer

    Returns Promise<void>

Static withTmpDir

  • withTmpDir(cacheDir: string): FSCache

  • Parameters

    • cacheDir: string

    Returns FSCache

Generated using TypeDoc