Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkorszun committed Oct 22, 2020
1 parent 174a465 commit 131994e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ GenRMQ.Publisher.publish(Publisher, Jason.encode!(%{msg: "msg"}))
- [Consumer with custom queue configuration][guide_consumer_with_custom_queue_configuration]
- [Consumer without deadletter configuration][without_deadletter_configuration]
- [Consumer with quorum queues][with_quorum_queue_type]
- [Publisher with default exchange][publisher_with_default_exchange]

### Metrics

Expand Down Expand Up @@ -197,6 +198,7 @@ Copyright (c) 2018 - 2020 Meltwater Inc. [underthehood.meltwater.com][undertheho
[guide_consumer_with_custom_queue_configuration]: https://github.com/meltwater/gen_rmq/blob/master/documentation/guides/consumer/with_custom_queue_configuration.md
[without_deadletter_configuration]: https://github.com/meltwater/gen_rmq/blob/master/documentation/guides/consumer/without_deadletter_configuration.md
[with_quorum_queue_type]: https://github.com/meltwater/gen_rmq/blob/master/documentation/guides/consumer/with_quorum_queue_type.md
[publisher_with_default_exchange]: https://github.com/meltwater/gen_rmq/blob/master/documentation/guides/publisher/with_default_exchange.md
[consumer_telemetry_events]: https://github.com/meltwater/gen_rmq/blob/master/lib/gen_rmq/consumer/telemetry.ex
[publisher_telemetry_events]: https://github.com/meltwater/gen_rmq/blob/master/lib/gen_rmq/publisher/telemetry.ex
[trusted_commiters]: https://github.com/meltwater/gen_rmq/blob/master/TRUSTED-COMMITTERS.md
Expand Down
6 changes: 6 additions & 0 deletions lib/binding.ex
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ defmodule GenRMQ.Binding do
@moduledoc """
This module defines common methods for
declaring consumer bindings and exchanges.
Supported exchange types:
* `direct` - sample config: `exchange: {:direct, exchange_name}`
* `fanout` - sample config: `exchange: {:fanout, exchange_name}`
* `topic` - sample config: `exchange: {:topic, exchange_name}`
* `default` - sample config: `exchange: :default`.
"""

@type exchange :: String.t() | {exchange_kind(), String.t()} | :default
Expand Down

0 comments on commit 131994e

Please sign in to comment.