triggers.md

Triggers Component

Any file-indexing is handled by Triggers, which watch for changes to specific paths and archives, then queue jobs automatically when a change is detected.

In some ways, Triggers are an alternative control mechanism to HTTP requests. Rather than a GET/POST, clients write and upload files which cause updates in the hypercloud instance.

Triggers API

triggers.add(pathSpec, handler) // add a trigger & handler function
triggers.list()                 // list the active triggers
triggers.remove(handerId)       // remove a trigger & handler

The pathSpec may be a string or regex.

Example usage:

triggers.add('/proofs/hypercloud.com', (archive, entry) => {
  jobs.queue('verify-profile-dat', { datUrl: archive.url })
})

triggers.add(new RegExp('/dats/[a-z0-9]'), (archive, entry) => {
  // ...
})