Cache

Index

Constructors

• constructor

Properties

• cacheKey
• cacheSpec
• check
• configuration
• cwd
• immutable
• markedFiles

Accessors

• mirrorCwd

Methods

• fetchPackageFromCache
• getChecksumFilename
• getLocatorMirrorPath
• getLocatorPath
• getVersionFilename
• isChecksumCompatible
• setup
• find
• getCacheKey

Constructors

constructor

• new Cache(cacheCwd: PortablePath, __namedParameters: { check?: boolean; configuration: Configuration; immutable?: boolean }): Cache

• Parameters

  • cacheCwd: PortablePath

  • __namedParameters: { check?: boolean; configuration: Configuration; immutable?: boolean }

  Returns Cache

Properties

publicreadonlycacheKey

cacheKey: string

publicreadonlycacheSpec

cacheSpec: string

publicreadonlycheck

check: boolean

publicreadonlyconfiguration

configuration: Configuration

publicreadonlycwd

cwd: PortablePath

publicreadonlyimmutable

immutable: boolean

publicreadonlymarkedFiles

markedFiles: Set<PortablePath> = ...

Accessors

mirrorCwd

• get mirrorCwd(): null | PortablePath

• Returns null | PortablePath

Methods

fetchPackageFromCache

• fetchPackageFromCache(locator: Locator, expectedChecksum: null | string, __namedParameters: { loader?: () => Promise<ZipFS>; onHit?: () => void; onMiss?: () => void } & CacheOptions): Promise<[FakeFS<PortablePath>, () => void, null | string]>

• Parameters

  • locator: Locator

  • expectedChecksum: null | string

  • __namedParameters: { loader?: () => Promise<ZipFS>; onHit?: () => void; onMiss?: () => void } & CacheOptions

  Returns Promise<[FakeFS<PortablePath>, () => void, null | string]>

getChecksumFilename

• getChecksumFilename(locator: Locator, checksum: string): Filename

• Parameters

  • locator: Locator

  • checksum: string

  Returns Filename

getLocatorMirrorPath

• getLocatorMirrorPath(locator: Locator): null | PortablePath

• Parameters

  • locator: Locator

  Returns null | PortablePath

getLocatorPath

• getLocatorPath(locator: Locator, expectedChecksum: null | string): PortablePath

• Parameters

  • locator: Locator

  • expectedChecksum: null | string

  Returns PortablePath

getVersionFilename

• getVersionFilename(locator: Locator): Filename

• Parameters

  • locator: Locator

  Returns Filename

isChecksumCompatible

• isChecksumCompatible(checksum: string): boolean

• Parameters

  • checksum: string

  Returns boolean

setup

• setup(): Promise<void>

• Returns Promise<void>

staticfind

• find(configuration: Configuration, __namedParameters?: { check?: boolean; immutable?: boolean }): Promise<Cache>

• Parameters

  • configuration: Configuration

  • __namedParameters: { check?: boolean; immutable?: boolean } = {}

  Returns Promise<Cache>

staticgetCacheKey

• getCacheKey(configuration: Configuration): { cacheKey: string; cacheSpec: string }

• Parameters

  • configuration: Configuration

  Returns { cacheKey: string; cacheSpec: string }

  • cacheKey: string

  • cacheSpec: string