@amykit/plugin-file-queue

A queue kept as one file per item, claimed by rename.

A plugin for amy. It provides the queue port.

Install

npm install -g @amykit/plugin-file-queue

Then name it in ~/.amy/config.yaml:

workflows:
  your-profile:
    plugins:
      - "@amykit/plugin-file-queue"

Configuration

plugins:
  "@amykit/plugin-file-queue":
    directory: "queue"
    retentionDays: 7
    staleClaimMs: 1800000

| Setting | Type | Required | Default | What it is | | :-- | :-- | :-- | :-- | :-- | | directory | string | no | queue | where the queue is kept, relative to the state directory. One per workflow, so two profiles under one .amy do not claim each other's work | | retentionDays | number | no | 7 | how long a finished queue item is kept before it is pruned | | staleClaimMs | number | no | 1800000 | how long a claimed item may sit before it counts as abandoned |

Every field is checked at boot against the schema this package declares. A key that is not one of the above is a refusal naming the plugin and the key, not a setting that silently never applied.

Where the reasoning is

• Writing a plugin
• Reference: plugins
• Ports and the registry

Licence

MIT