Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "core/goal/cache/goalCaching"

Index

Interfaces

Variables

Functions

Object literals

Variables

Const CacheInputGoalDataKey

CacheInputGoalDataKey: "@atomist/sdm/input" = "@atomist/sdm/input"

Const CacheOutputGoalDataKey

CacheOutputGoalDataKey: "@atomist/sdm/output" = "@atomist/sdm/output"

Const DefaultGoalCache

DefaultGoalCache: CompressingGoalCache = new CompressingGoalCache()

Functions

cachePut

  • 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

  • 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

  • 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

isDirectoryPattern

  • isDirectoryPattern(toBeDetermined: any): toBeDetermined is DirectoryPattern

isGlobFilePattern

  • isGlobFilePattern(toBeDetermined: any): toBeDetermined is GlobFilePattern

pushTestSucceeds

resolveClassifierPath

sanitizeClassifier

  • sanitizeClassifier(classifier: string): string

  • Sanitize classifier for use in path. Replace any characters which might cause problems on POSIX or MS Windows with "_", including path separators. Ensure resulting file is not "hidden".

    Parameters

    • classifier: string

    Returns string

Object literals

Const NoOpGoalProjectListenerRegistration

NoOpGoalProjectListenerRegistration: object

name

name: string = "NoOpListener"

pushTest

pushTest: PushTest = AnyPush

listener

Generated using TypeDoc