Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitrydigi authored Oct 29, 2023
1 parent 026c282 commit 84c847f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ Consumer will receive and delete messages from the SQS queue. Ensure `sqs:Receiv

### `Consumer.create(options)`

Creates a new SQS consumer using the [defined options](https://bbc.github.io/sqs-consumer/interfaces/ConsumerOptions.html).
Creates a new SQS consumer using the [defined options](https://dmitrydigi.github.io/sqs-consumer/interfaces/ConsumerOptions.html).

### `consumer.start()`

Start polling the queue for messages.

### `consumer.stop(options)`

Stop polling the queue for messages. [You can find the options definition here](https://bbc.github.io/sqs-consumer/interfaces/StopOptions.html).
Stop polling the queue for messages. [You can find the options definition here](https://dmitrydigi.github.io/sqs-consumer/interfaces/StopOptions.html).

By default, the value of `abort` is set to `false` which means pre existing requests to AWS SQS will still be made until they have concluded. If you would like to abort these requests instead, pass the abort value as `true`, like so:

Expand All @@ -127,11 +127,11 @@ Returns the current polling state of the consumer: `true` if it is actively poll

Updates the provided option with the provided value.

You can [find out more about this here](https://bbc.github.io/sqs-consumer/classes/Consumer.html#updateOption).
You can [find out more about this here](https://dmitrydigi.github.io/sqs-consumer/classes/Consumer.html#updateOption).

### Events

Each consumer is an [`EventEmitter`](https://nodejs.org/api/events.html) and [emits these events](https://bbc.github.io/sqs-consumer/interfaces/Events.html).
Each consumer is an [`EventEmitter`](https://nodejs.org/api/events.html) and [emits these events](https://dmitrydigi.github.io/sqs-consumer/interfaces/Events.html).

## Contributing

Expand Down

0 comments on commit 84c847f

Please sign in to comment.