Interface GoalCache

Goal cache interface for storing and retrieving arbitrary files produced by the execution of a goal.

see: FileSystemGoalCache`

Hierarchy

GoalCache

Implemented by

Index

Methods

Methods

put

put(gi: GoalInvocation, p: GitProject, files: string | string[], classifier?: string): Promise<string>

- Defined in lib/core/goal/cache/goalCaching.ts:54
Add a set of files (or directories) to the cache.

Parameters
- gi: GoalInvocation
  
  The goal invocation for which the cache needs to be stored.
- p: GitProject
  
  The project where the files (or directories) reside.
- files: string | string[]
  
  The files (or directories) to be cached.
- Optional classifier: string
  
  An optional classifier to identify the set of files (or directories to be cached).
Returns Promise<string>

remove

remove(gi: GoalInvocation, classifier?: string): Promise<void>

- Defined in lib/core/goal/cache/goalCaching.ts:71
Remove files from the cache.

Parameters
- gi: GoalInvocation
  
  The goal invocation for which the cache needs to be removed.
- Optional classifier: string
  
  Optionally the classifier of the cache for the files to be removed. If not defined, all classifiers are removed.
Returns Promise<void>

retrieve

retrieve(gi: GoalInvocation, p: GitProject, classifier?: string): Promise<void>

- Defined in lib/core/goal/cache/goalCaching.ts:63
Retrieve files from the cache.

Parameters
- gi: GoalInvocation
  
  The goal invocation for which the cache needs to be restored.
- p: GitProject
  
  he project where the files (or directories) need to be restored in.
- Optional classifier: string
  
  Optionally the classifier of the cache for the files to be restored. If not defined, all caches for the GoalInvocation are restored.
Returns Promise<void>

Generated using TypeDoc