Raxol.Core.Runtime.Plugins.FileWatcherBehaviour behaviour (Raxol v2.0.1)

View Source

Behavior for file watcher plugins.

Summary

Callbacks

Callback for handling file change events.

Callback for starting the file watcher.

Callback for stopping the file watcher.

Callbacks

handle_file_change(file_path, change_type)

@callback handle_file_change(file_path :: String.t(), change_type :: atom()) ::
  :ok | {:error, term()}

Callback for handling file change events.

start_watching(paths, opts)

@callback start_watching(paths :: [String.t()], opts :: keyword()) ::
  {:ok, pid()} | {:error, term()}

Callback for starting the file watcher.

stop_watching(watcher_pid)

@callback stop_watching(watcher_pid :: pid()) :: :ok

Callback for stopping the file watcher.