update docs for useQueueUrlAsEndpoint (#499)

bbc · May 10, 2024 · 73c5463 · 73c5463
1 parent f4b071b
commit 73c5463
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/types.ts b/src/types.ts
@@ -80,7 +80,8 @@ export interface ConsumerOptions {
    */
   region?: string;
   /**
-   * If false uses the QueueUrl hostname as the endpoint.
+   * Set this value to false to ignore the `queueUrl` and use the
+   * client's resolved endpoint, which may be a custom endpoint.
    * @defaultValue `true`
    */
   useQueueUrlAsEndpoint?: boolean;