Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "goal/cache/goalCaching"

Index

Interfaces

Variables

Functions

Object literals

Variables

Const DefaultGoalCache

DefaultGoalCache: NoOpGoalCache = new NoOpGoalCache()

Functions

cachePut

  • cachePut(options: GoalCacheOptions, classifier?: string, ...classifiers: string[]): GoalProjectListenerRegistration

  • Goal listener that performs caching after a goal has been run.

    Parameters

    • options: GoalCacheOptions

      The options for caching

    • Optional classifier: string

      Whether only a specific classifier, as defined in the options, needs to be cached. If omitted, all classifiers are cached.

    • Rest ...classifiers: string[]

      Additional classifiers that need to be created.

    Returns GoalProjectListenerRegistration

cacheRemove

  • cacheRemove(options: GoalCacheOptions, classifier?: string, ...classifiers: string[]): GoalProjectListenerRegistration

  • Goal listener that cleans up the cache restores after a goal has been run.

    Parameters

    • options: GoalCacheOptions

      The options for caching

    • Optional classifier: string

      Whether only a specific classifier, as defined in the options, needs to be removed. If omitted, all classifiers are removed.

    • Rest ...classifiers: string[]

      Additional classifiers that need to be removed.

    Returns GoalProjectListenerRegistration

cacheRestore

  • cacheRestore(options: GoalCacheRestoreOptions, classifier?: string, ...classifiers: string[]): GoalProjectListenerRegistration

  • Goal listener that performs cache restores before a goal has been run.

    Parameters

    • options: GoalCacheRestoreOptions

      The options for caching

    • Optional classifier: string

      Whether only a specific classifier, as defined in the options, needs to be restored. If omitted, all classifiers defined in the options are restored.

    • Rest ...classifiers: string[]

      Additional classifiers that need to be restored.

    Returns GoalProjectListenerRegistration

cacheStore

getFilePathsThroughPattern

  • getFilePathsThroughPattern(project: Project, globPattern: string | string[]): Promise<string[]>

invokeCacheMissListeners

isCacheEnabled

  • isCacheEnabled(gi: GoalInvocation): boolean

isDirectoryPattern

  • isDirectoryPattern(toBeDetermined: any): boolean

isGlobFilePattern

  • isGlobFilePattern(toBeDetermined: any): boolean

pushTestSucceeds

  • pushTestSucceeds(pushTest: PushTest, gi: GoalInvocation, p: GitProject): Promise<boolean>

Object literals

Const NoOpGoalProjectListenerRegistration

NoOpGoalProjectListenerRegistration: object

name

name: string = "NoOpListener"

pushTest

pushTest: PushTest = AnyPush

listener

  • listener(): Promise<void>

Generated using TypeDoc