Skip to content

Commit

Permalink
break the long property names in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
icebob committed Oct 17, 2021
1 parent 1c707e8 commit 28ddfa1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,14 +322,15 @@ module.exports = {
| `maxInFlight` | `Number` | `1` | * | Max number of messages under processing at the same time.
| `deadLettering.enabled` | `Boolean` | `false` | * | Enable "Dead-lettering" feature. |
| `deadLettering.queueName` | `String` | `FAILED_MESSAGES` | * | Name of dead-letter queue. |
| `redis` | `Object`, `String`, `Number` | `null` | Redis | Redis connection options. More info [here](https://github.com/luin/ioredis#connect-to-redis)
| `cluster.nodes` | `Array` | `null` | Redis | Redis Cluster nodes list. More info [here](https://github.com/luin/ioredis#cluster)
| `cluster.clusterOptions` | `Object` | `null` | Redis | Redis Cluster options. More info [here](https://github.com/luin/ioredis#cluster)
| `redis.consumerOptions.readTimeoutInterval` | `Number`| `0` | Redis | Maximum time (in milliseconds) while waiting for new messages. By default equals to 0, i.e., never timeout. More info [here](https://redis.io/commands/XREADGROUP#differences-between-xread-and-xreadgroup)
| `redis.consumerOptions.minIdleTime` | `Number` | `60 * 60 * 1000` | Redis | Time (in milliseconds) after which pending messages are considered NACKed and should be claimed. Defaults to 1 hour.
| `redis.consumerOptions.claimInterval` | `Number` | `100` | Redis | Interval (in milliseconds) between message claims.
| `redis.consumerOptions.startID` | `String` | `$` | Redis | Starting point when consumers fetch data from the consumer group. By default equals to `$`, i.e., consumers will only see new elements arriving in the stream. More info [here](https://redis.io/commands/XGROUP).
| `redis.consumerOptions.processingAttemptsInterval` | `Number` | `0` | Redis | Interval (in milliseconds) between message transfer into `FAILED_MESSAGES` channel.
| `redis` | `Object`, `String`, `Number` | `null` | Redis | Redis connection options. More info [here](https://github.com/luin/ioredis#connect-to-redis) |
| `redis.consumerOptions` `.readTimeoutInterval` | `Number`| `0` | Redis | Maximum time (in milliseconds) while waiting for new messages. By default equals to 0, i.e., never timeout. More info [here](https://redis.io/commands/XREADGROUP#differences-between-xread-and-xreadgroup)
| `redis.consumerOptions` `.minIdleTime` | `Number` | `60 * 60 * 1000` | Redis | Time (in milliseconds) after which pending messages are considered NACKed and should be claimed. Defaults to 1 hour.
| `redis.consumerOptions` `.claimInterval` | `Number` | `100` | Redis | Interval (in milliseconds) between message claims.
| `redis.consumerOptions` `..startID` | `String` | `$` | Redis | Starting point when consumers fetch data from the consumer group. By default equals to `$`, i.e., consumers will only see new elements arriving in the stream. More info [here](https://redis.io/commands/XGROUP).
| `redis.consumerOptions` `..processingAttemptsInterval` | `Number` | `0` | Redis | Interval (in milliseconds) between message transfer into `FAILED_MESSAGES` channel.
| `cluster` | `Object` | `null` | Redis | Redis cluster connection options. More info [here](https://github.com/luin/ioredis#cluster) |
| ...`nodes` | `Array` | `null` | Redis | Redis Cluster nodes list. |
| ...`clusterOptions` | `Object` | `null` | Redis | Redis Cluster options. |
| `amqp.url` | `String` | `null` | AMQP | Connection URI.
| `amqp.socketOptions` | `Object` | `null` | AMQP | AMQP lib socket configuration. More info [here](http://www.squaremobius.net/amqp.node/channel_api.html#connect).
| `amqp.queueOptions` | `Object` | `null` | AMQP | AMQP lib queue configuration. More info [here](http://www.squaremobius.net/amqp.node/channel_api.html#channel_assertQueue).
Expand Down

0 comments on commit 28ddfa1

Please sign in to comment.