Minor archive docs feedback

timgit / pg-boss

Queueing jobs in Postgres from Node.js like a boss

MIT License

2.13k stars 158 forks source link

Closed bhsiaoNFLX closed 3 years ago

bhsiaoNFLX commented 3 years ago

If the state conditional is:

function archive (schema) {
  ...
  state < '${states.active}' AND keepUntil < now()
  ...

I.e. configuration.md should really be:

"...created and retry state before it's archived"

Am I right?

Also, archiveCompletedAfterSeconds is currently missing documentation even though there's a unit test for it. It should be documented.

If you agree, happy to create a PR :)

timgit commented 3 years ago

Yes. Please open a PR. Thanks!

bhsiaoNFLX commented 3 years ago