Plugins

Plugins

Plugins are called with "events" (really just methods) at different points of the processing.

• fileUpdated(evt, api)
  • called when a file is added or updated
  • evt.file has details about the particular file
• fileDeleted(evt, api)
  • called when a file is deleted
  • evt.file has details about the particular file
• resourceUpdated(evt, api)
  • called when a resource is added or updated
  • evt.resource has details about the particular resource
• resourceDeleted(evt, api)
  • called when a resource is deleted
  • evt.resource has details about the particular resource
• bundleUpdated(evt, api)
  • called when a bundle is updated
  • evt.bundle has the bundle
  • evt.files has files that caused the trigger of this event
    • this might be a subset of files in the bundle
  • evt.resources has resources that caused the trigger of this event
    • this might be a subset of resources in the bundle
  • this event is deferred to the end of locator.parseBundle() for plugin optimization

All events receive an api object, which is an API back into the locator. This API is customized for plugins (and can/should evolve with plugin requirements).