bbc / sqs-consumer

Build Amazon Simple Queue Service (SQS) based applications without the boilerplate
https://bbc.github.io/sqs-consumer/
Other
1.71k stars 330 forks source link

update docs for useQueueUrlAsEndpoint #499

Closed tylermichael closed 1 month ago

tylermichael commented 1 month ago

The AWS docs for this property suggest the language here is backwards.

Description: The documentation says to set it to false to use the queueUrl as the endpoint, but the behavior is actually the opposite. Setting it to true (which is the default) makes the SQS client use the queueUrl as the endpoint. Setting it to false makes the SQS client use the resolved SQS endpoint, which would be the AWS region SQS endpoint by default.

Type of change:

Why is this change required?: The documentation is incorrect in how this property is used.

Code changes:


Checklist:

github-actions[bot] commented 1 month ago

CLA Assistant Lite bot CLA CHECK All Contributors have signed the CLA

tylermichael commented 1 month ago

I have read the CLA Document and I hereby sign the CLA

tylermichael commented 1 month ago

recheck

codeclimate[bot] commented 1 month ago

Code Climate has analyzed commit 190d9534 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 97.9% (0.0% change).

View more on Code Climate.