KC's Workspace
    Preparing search index...

    Interface WatcherFileWatcherOptions

    interface WatcherFileWatcherOptions {
        compareContentsForPolling?: boolean;
        debounceDelay?: number;
        debounceTickRate?: number;
        pollInterval?: number;
        useDebounce?: boolean;
        usePolling?: boolean;
    }
    Index

    Properties

    compareContentsForPolling?: boolean

    Whether to compare file contents for poll-based watchers. When enabled, poll watchers will check file contents to determine if they actually changed.

    This option is only used when usePolling is true.

    false
    
    debounceDelay?: number

    Debounce delay in milliseconds for fs-level debounced watchers. Only used when useDebounce is true.

    10
    
    debounceTickRate?: number

    Tick rate in milliseconds for the debouncer's internal polling. Only used when useDebounce is true. When undefined, auto-selects 1/4 of debounceDelay.

    pollInterval?: number

    Interval between each poll in milliseconds.

    This option is only used when usePolling is true.

    100
    
    useDebounce?: boolean

    Whether to use debounced event delivery at the filesystem level. This coalesces rapid filesystem events before they reach the build coordinator.

    false
    
    usePolling?: boolean

    Whether to use polling-based file watching instead of native OS events.

    Polling is useful for environments where native FS events are unreliable, such as network mounts, Docker volumes, or WSL2.

    false