Class SQSExtendedConsumer

Index

Constructors

Accessors

Methods

on start stop updateOption

Constructors

constructor

new SQSExtendedConsumer(
    options: ExtendedOptions & {
        handleMessage: (message: any) => Promise<void>;
    },
): SQSExtendedConsumer
Parameters
- options: ExtendedOptions & { handleMessage: (message: any) => Promise<void> }
Returns SQSExtendedConsumer
- Defined in src/consumer.ts:36

Accessors

status

get status(): { isPolling: boolean; isRunning: boolean }
Returns the current status of the consumer. This includes whether it is running or currently polling.

Returns { isPolling: boolean; isRunning: boolean }
- Defined in src/consumer.ts:167

Methods

on

on(event: keyof Events, listener: (...args: any[]) => void): SQSExtendedConsumer
Access to event emitter methods. Use this to attach event handlers to the consumer.
Parameters
- event: keyof Events
- listener: (...args: any[]) => void
Returns SQSExtendedConsumer
Example
```
consumer.on('message_received', (message) => {
  console.log(message);
});
```
- Defined in src/consumer.ts:179

start

start(): void
Start polling the queue for messages.

Returns void
- Defined in src/consumer.ts:151

stop

stop(options?: StopOptions): void
Stop polling the queue for messages.
Parameters
- Optionaloptions: StopOptions
  Stop options (e.g. { abort: true } to abort current requests)
Returns void
- Defined in src/consumer.ts:159

updateOption

updateOption(option: UpdatableOptions, value: number): void
Validates and then updates the provided option to the provided value.
Parameters
- option: UpdatableOptions
  The option to validate and then update
- value: number
  The value to set the provided option to
Returns void
- Defined in src/consumer.ts:189