Skip to content

docs(jetstream_consumers): Document ability to set JetStream consumer configuration #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nullmoose wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(jetstream_consumers): Document ability to set JetStream consumer configuration #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Readme.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ bougyman <me@bougyman.com>
:conventional-commits: https://www.conventionalcommits.org/en/v1.0.0/[Conventional Commits]
:dry-configurable: https://github.com/dry-rb/dry-configurable[Dry::Configurable]
:dry-monads: https://github.com/dry-rb/dry-monads[Dry::Monads]
:jetstream-consumer-config: https://docs.nats.io/nats-concepts/jetstream/consumers#configuration[Jetstream Consumer Configuration]

Leopard is a small framework for building concurrent {service-api} workers.
It uses `Concurrent::FixedThreadPool` to manage multiple workers in a single process and provides a
Expand Down Expand Up @@ -116,6 +117,13 @@ class EventConsumer
end
----

Any configuration options available for JetStream consumers can be passed via snakeified keys
in the `consumer` hash, with the exception of `durable_name`, `filter_subject` and `ack_policy`.
`durable_name` and `filter_subject` are both derived from the endpoint, and `ack_policy` is always
set to `explicit`.
Comment on lines +120 to +123

@nullmoose nullmoose Jun 12, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's already an example key present in the existing example code above this change. Should already be clear imo


{jetstream-consumer-config}

JetStream handlers receive the same `Rubyists::Leopard::MessageWrapper` as service endpoints.
Leopard will:

Expand Down
Loading