Skip to content

chore: Remove AckableMessage.reject from docs #542

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: Remove AckableMessage.reject from docs #542

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
7 changes: 2 additions & 5 deletions docs/extending-taskiq/broker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ As a broker developer, please send only raw bytes from the `message` field of a
## Acknowledgement

The `listen` method should yield raw bytes of a message.
But if your broker supports acking or rejecting messages, the broker should return `taskiq.AckableMessage`
with required fields.
But if your broker supports acking messages, the broker should return `taskiq.AckableMessage` with the required field.

For example:

Expand All @@ -40,9 +39,7 @@ async def listen(self) -> AsyncGenerator[AckableMessage, None]:
# Ack is a function that takes no parameters.
# So you either set here method of a message,
# or you can make a closure.
ack=message.ack
# Can be set to None if broker doesn't support it.
reject=message.reject
ack=message.ack,
)
```

Expand Down