Class FileSystemWatcher

Parameters

• config: {
      debounceMs?: number;
      ignored: string[];
      moveDetection?: { bufferMs: number; enabled: boolean };
      paths: (
          | string
          | {
              path: string;
              vcs?: {
                  accessToken?: string;
                  author?: { email: string; name: string };
                  branch?: string;
                  circuitBreakerCooldownMs?: number;
                  commitMessage?: {
                      apiKey?: string;
                      enabled: boolean;
                      model: string;
                      provider: string;
                  };
                  commitThrottleMs?: number;
                  defaultAccessToken?: string;
                  enabled?: boolean;
                  maxBatchSize?: number;
                  maxConsecutiveFailures?: number;
                  remote?: string;
                  retention?: {
                      maxAgeDays: number;
                      maxVersions: number;
                      squashCron: string;
                  };
                  staleLockThresholdMs?: number;
              };
          }
      )[];
      pollIntervalMs?: number;
      respectGitignore?: boolean;
      stabilityThresholdMs?: number;
      usePolling?: boolean;
  }

  Watch configuration.

  • OptionaldebounceMs?: number

    Debounce delay in milliseconds for file change events.

  • ignored: string[]

    Glob patterns to ignore.

  • OptionalmoveDetection?: { bufferMs: number; enabled: boolean }

    Move detection configuration for correlating unlink+add as file moves.

    • bufferMs: number

      Buffer time in ms for holding unlink events before treating as deletes. Default: 2000.

    • enabled: boolean

      Enable move correlation. Default: true.

  • paths: (
        | string
        | {
            path: string;
            vcs?: {
                accessToken?: string;
                author?: { email: string; name: string };
                branch?: string;
                circuitBreakerCooldownMs?: number;
                commitMessage?: {
                    apiKey?: string;
                    enabled: boolean;
                    model: string;
                    provider: string;
                };
                commitThrottleMs?: number;
                defaultAccessToken?: string;
                enabled?: boolean;
                maxBatchSize?: number;
                maxConsecutiveFailures?: number;
                remote?: string;
                retention?: {
                    maxAgeDays: number;
                    maxVersions: number;
                    squashCron: string;
                };
                staleLockThresholdMs?: number;
            };
        }
    )[]

    Glob patterns or watch path objects to watch.

  • OptionalpollIntervalMs?: number

    Polling interval in milliseconds.

  • OptionalrespectGitignore?: boolean

    Whether to respect .gitignore files when processing.

  • OptionalstabilityThresholdMs?: number

    Time in milliseconds a file must be stable before processing.

  • OptionalusePolling?: boolean

    Whether to use polling instead of native watchers.

• queue: EventQueue

  The event queue.

• processor: DocumentProcessorInterface

  The document processor.

• logger: Logger

  The logger instance.

• options: FileSystemWatcherOptions = {}

  Optional health/fatal error options.