Skip to content
ChasquiMQ ChasquiMQ

Reference

Reference is information-oriented. Look up a class, method, option type, error code, or CLI flag. For tutorials, see /start. For how-tos, see /guides. For mental model, see /concepts.

Everything here is exhaustive by design. Pages are dense; that is the job. The voice and density follow the Rust standard library reference — direct, factual, no marketing.

In this section

Section titled “In this section”
  • Node.js API — Queue, Worker, Job, QueueEvents, every option type and every method signature.
  • Python API — Queue, Worker, Job, QueueEvents, QueueEvent, RepeatPattern, BackoffSpec, MissedFiresPolicy, RepeatableMeta. Mirrors the Node surface.
  • Rust API — engine internals: Producer, Consumer, Promoter, Scheduler, every config struct, every observability event, the error enum.
  • CLI — chasqui inspect, chasqui dlq, chasqui repeatable, chasqui watch, chasqui events. One section per subcommand.
  • Options index — the cross-language cheat-sheet you reach for when tuning concurrency, retry budgets, payload size, or DLQ depth. Three columns: option, where it lives, what it controls.
  • Error codes — every CMQ-* code the engine and shims emit, with When, Why, Fix, and See also for each. Stable across releases.
  • Wire format — the on-Redis byte layout: MessagePack envelope, stream-entry fields, idempotent-add header, ack semantics. For the engineer at a redis-cli prompt.

Conventions

Section titled “Conventions”

Code blocks are language-tagged so syntax highlighting fires. File paths in prose are code-formatted (chasquimq/src/producer/mod.rs). Per-option defaults are bolded inside the description, not in a separate column. Multi-language method pairs use synced tabs so the Node and Python shapes sit side by side.