Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/heft > IHeftTaskRunIncrementalHookOptions

IHeftTaskRunIncrementalHookOptions interface

Options provided to the 'runIncremental' hook.

Signature:

export interface IHeftTaskRunIncrementalHookOptions extends IHeftTaskRunHookOptions 

Extends: IHeftTaskRunHookOptions

Properties

Property

Modifiers

Type

Description

requestRun

readonly

() => void

A callback that can be invoked to tell the Heft runtime to schedule an incremental run of this task. If a run is already pending, does nothing.

watchFs

readonly

IWatchFileSystem

Access to the file system view that powers watchGlobAsync. This is useful for plugins that do their own file system operations but still want to leverage Heft for watching.

watchGlobAsync

readonly

WatchGlobFn

Reads the specified globs and returns the result, filtering out files that have not changed since the last execution. All file system calls while reading the glob are tracked and will be watched for changes.

If a change to the monitored files is detected, the task will be scheduled for re-execution.