Skip to content

v3.0.0

Choose a tag to compare

@divmgl divmgl released this 19 Jan 09:35
· 21 commits to master since this release

Version 3: UInt8Array, ESM/CJS packages

This version of Jackd brings some important bug fixes and changes that both make Jackd more accurate to the Beanstalkd protocol and better suited for JavaScript runtimes like Bun (sorry Deno stans, no support yet). It's a full version bump because there are some breaking changes to the API.

Breaking changes

  • Job IDs are now integers (they were previously strings)
    • This change was made for protocol correctness
  • Usage of Buffer has been phased out in favor of UInt8Array
    • reserve now returns the payload as a UTF-8 string, rather than a Buffer
    • There is a new reserveRaw method that allows you to receive the raw payload as an array of bytes (UInt8Array)
    • This change was made to allow Jackd to eventually transition into a multi runtime library
  • Minimum supported Node.js version is now v18 LTS

Bug fixes

  • stats, list-tubes and other statistics commands no longer incorrectly require job IDs
  • No more any: the entire library is now fully typed
  • Jackd now works both in ESM and CJS contexts

Full Changelog: v2.2.2...v3.0.0