#cp.sourcewatcher

Watches folders for specific file extensions and reloads the app if they change.


#API Overview

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Methods

Signaturecp.sourcewatcher:filesChanged(files, flagTables) -> boolean
TypeMethod
DescriptionChecks that the file that triggered the Path Watcher matches the extension given.
Parameters
  • files - Table of files to check as strings
  • flagTables - Table of flagTables (see: hs.pathwatcher.new)
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 67

Signaturecp.sourcewatcher:matchesExtensions(file) -> boolean
TypeMethod
DescriptionChecks that the file that triggered the Path Watcher matches the extension given.
Parameters
  • file - The file as string
Returns
  • A boolean value
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 39

Signaturecp.sourcewatcher.new(extensions) -> sourcewatcher
TypeMethod
DescriptionCreates a new sourcewatcher instance.
Parameters
  • extensions - Extensions
Returns
  • A sourcewatcher instance
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 20

Signaturecp.sourcewatcher:start() -> none
TypeMethod
DescriptionStarts a Source Watcher.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 129

Signaturecp.sourcewatcher:stop() -> none
TypeMethod
DescriptionStops a Source Watcher.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 112

Signaturecp.sourcewatcher:watchPath(path) -> sourcewatcher
TypeMethod
DescriptionWatches a path.
Parameters
  • path - The path you want to watch as a string.
Returns
  • sourcewatcher
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/sourcewatcher/init.lua line 93