sqs-consumer 7.0.3 → 7.1.0-canary.2

package/.github/DISCUSSION_TEMPLATE/feature-request.yml

@@ -0,0 +1,17 @@
+body:
+  - type: textarea
+    attributes:
+      label: Background
+      description: Why do you think this feature is needed? Are there current alternatives?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Objectives
+      description: What should this feature request aim to address?
+      value: |
+        1.
+        2.
+        3.
+    validations:
+      required: true

package/.github/DISCUSSION_TEMPLATE/help.yml

@@ -0,0 +1,13 @@
+body:
+  - type: textarea
+    attributes:
+      label: Summary
+      description: What do you need help with?
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Example
+      description: A link to a minimal reproduction is helpful for debugging!
+    validations:
+      required: false

package/README.md

@@ -12,14 +12,14 @@ Build SQS-based applications without the boilerplate. Just define an async funct
 To install this package, simply enter the following command into your terminal (or the variant of whatever package manager you are using):
 
 ```bash
-npm install --save-dev sqs-consumer
+npm install sqs-consumer
 ```
 
 > **Note**
 > This library assumes you are using [AWS SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/index.html). If you are using v2, please install v5.8.0:
 >
 > ```bash
-> npm install sqs-consumer@5.8.0 --save-dev
+> npm install sqs-consumer@5.8.0
 > ```
 
 ### Node version
@@ -127,6 +127,12 @@ By default, the value of `abort` is set to `false` which means pre existing requ
 
 Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
 
+### `consumer.updateOption(option, value)`
+
+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).
+
 ### 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).

package/dist/consumer.d.ts

@@ -1,4 +1,4 @@
-import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
+import { ConsumerOptions, TypedEventEmitter, StopOptions, UpdatableOptions } from './types';
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
  */
@@ -37,6 +37,17 @@ export declare class Consumer extends TypedEventEmitter {
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
      */
     get isRunning(): boolean;
+    /**
+     * Updates visibilityTimeout to the provided value.
+     * @param value The value to set visibilityTimeout to
+     */
+    private updateVisibilityTimeout;
+    /**
+     * Updates the provided option to the provided value.
+     * @param option The option that you want to update
+     * @param value The value to set the option to
+     */
+    updateOption(option: UpdatableOptions, value: ConsumerOptions[UpdatableOptions]): void;
     /**
      * Emit one of the consumer's error events depending on the error received.
      * @param err The error object to forward on

package/dist/consumer.js

@@ -61,6 +61,7 @@ class Consumer extends types_1.TypedEventEmitter {
         if (this.stopped) {
             debug('Starting consumer');
             this.stopped = false;
+            this.emit('started');
             this.poll();
         }
     }
@@ -91,6 +92,36 @@ class Consumer extends types_1.TypedEventEmitter {
     get isRunning() {
         return !this.stopped;
     }
+    /**
+     * Updates visibilityTimeout to the provided value.
+     * @param value The value to set visibilityTimeout to
+     */
+    updateVisibilityTimeout(value) {
+        if (typeof value !== 'number') {
+            throw new Error('visibilityTimeout must be a number');
+        }
+        if (typeof value !== 'number' ||
+            (this.heartbeatInterval && value <= this.heartbeatInterval)) {
+            throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+        }
+        debug(`Updating the visibilityTimeout option to the value ${value}`);
+        this.visibilityTimeout = value;
+        this.emit('option_updated', 'visibilityTimeout', value);
+    }
+    /**
+     * Updates the provided option to the provided value.
+     * @param option The option that you want to update
+     * @param value The value to set the option to
+     */
+    updateOption(option, value) {
+        switch (option) {
+            case 'visibilityTimeout':
+                this.updateVisibilityTimeout(value);
+                break;
+            default:
+                throw new Error(`The update ${option} cannot be updated`);
+        }
+    }
     /**
      * Emit one of the consumer's error events depending on the error received.
      * @param err The error object to forward on

package/dist/types.d.ts

@@ -105,6 +105,7 @@ export interface ConsumerOptions {
      */
     handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
+export type UpdatableOptions = 'visibilityTimeout';
 export interface StopOptions {
     /**
      * Default to `false`, if you want the stop action to also abort requests to SQS
@@ -149,10 +150,18 @@ export interface Events {
      * Fired when requests to SQS were aborted.
      */
     aborted: [];
+    /**
+     * Fired when the consumer starts its work..
+     */
+    started: [];
     /**
      * Fired when the consumer finally stops its work.
      */
     stopped: [];
+    /**
+     * Fired when an option is updated
+     */
+    option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
 export declare class TypedEventEmitter extends EventEmitter {
     /**

package/dist/types.js

@@ -17,7 +17,7 @@ class TypedEventEmitter extends events_1.EventEmitter {
      * @param listener A function to trigger when the event is emitted
      */
     once(event, listener) {
-        return super.on(event, listener);
+        return super.once(event, listener);
     }
     /**
      * Emits an event with the provided arguments

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "7.0.3",
+  "version": "7.1.0-canary.2",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/consumer.ts

@@ -17,7 +17,12 @@ import {
 } from '@aws-sdk/client-sqs';
 import Debug from 'debug';
 
-import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
+import {
+  ConsumerOptions,
+  TypedEventEmitter,
+  StopOptions,
+  UpdatableOptions
+} from './types';
 import { autoBind } from './bind';
 import {
   SQSError,
@@ -93,6 +98,7 @@ export class Consumer extends TypedEventEmitter {
     if (this.stopped) {
       debug('Starting consumer');
       this.stopped = false;
+      this.emit('started');
       this.poll();
     }
   }
@@ -132,6 +138,47 @@ export class Consumer extends TypedEventEmitter {
     return !this.stopped;
   }
 
+  /**
+   * Updates visibilityTimeout to the provided value.
+   * @param value The value to set visibilityTimeout to
+   */
+  private updateVisibilityTimeout(value: ConsumerOptions['visibilityTimeout']) {
+    if (typeof value !== 'number') {
+      throw new Error('visibilityTimeout must be a number');
+    }
+
+    if (
+      typeof value !== 'number' ||
+      (this.heartbeatInterval && value <= this.heartbeatInterval)
+    ) {
+      throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+    }
+
+    debug(`Updating the visibilityTimeout option to the value ${value}`);
+
+    this.visibilityTimeout = value;
+
+    this.emit('option_updated', 'visibilityTimeout', value);
+  }
+
+  /**
+   * Updates the provided option to the provided value.
+   * @param option The option that you want to update
+   * @param value The value to set the option to
+   */
+  public updateOption(
+    option: UpdatableOptions,
+    value: ConsumerOptions[UpdatableOptions]
+  ) {
+    switch (option) {
+      case 'visibilityTimeout':
+        this.updateVisibilityTimeout(value);
+        break;
+      default:
+        throw new Error(`The update ${option} cannot be updated`);
+    }
+  }
+
   /**
    * Emit one of the consumer's error events depending on the error received.
    * @param err The error object to forward on

package/src/types.ts

@@ -106,6 +106,8 @@ export interface ConsumerOptions {
   handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
 
+export type UpdatableOptions = 'visibilityTimeout';
+
 export interface StopOptions {
   /**
    * Default to `false`, if you want the stop action to also abort requests to SQS
@@ -151,10 +153,18 @@ export interface Events {
    * Fired when requests to SQS were aborted.
    */
   aborted: [];
+  /**
+   * Fired when the consumer starts its work..
+   */
+  started: [];
   /**
    * Fired when the consumer finally stops its work.
    */
   stopped: [];
+  /**
+   * Fired when an option is updated
+   */
+  option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
 
 export class TypedEventEmitter extends EventEmitter {
@@ -178,7 +188,7 @@ export class TypedEventEmitter extends EventEmitter {
     event: E,
     listener: (...args: Events[E]) => void
   ): this {
-    return super.on(event, listener);
+    return super.once(event, listener);
   }
   /**
    * Emits an event with the provided arguments