Interface ConsumerOptions

The options for the consumer.

interface ConsumerOptions {
    queueUrl: string;
    alwaysAcknowledge?: boolean;
    attributeNames?: QueueAttributeName[];
    authenticationErrorTimeout?: number;
    batchSize?: number;
    extendedAWSErrors?: boolean;
    handleMessageTimeout?: number;
    heartbeatInterval?: number;
    messageAttributeNames?: string[];
    messageSystemAttributeNames?: MessageSystemAttributeName[];
    pollingCompleteWaitTimeMs?: number;
    pollingWaitTimeMs?: number;
    region?: string;
    shouldDeleteMessages?: boolean;
    sqs?: SQSClient;
    terminateVisibilityTimeout?: number | boolean;
    useQueueUrlAsEndpoint?: boolean;
    visibilityTimeout?: number;
    waitTimeSeconds?: number;
    handleMessage?(message: Message): Promise<void | Message>;
    handleMessageBatch?(messages: Message[]): Promise<void | Message[]>;
    postReceiveMessageCallback?(): Promise<void>;
    preReceiveMessageCallback?(): Promise<void>;
}

Properties

queueUrl alwaysAcknowledge? attributeNames? authenticationErrorTimeout? batchSize? extendedAWSErrors? handleMessageTimeout? heartbeatInterval? messageAttributeNames? messageSystemAttributeNames? pollingCompleteWaitTimeMs? pollingWaitTimeMs? region? shouldDeleteMessages? sqs? terminateVisibilityTimeout? useQueueUrlAsEndpoint? visibilityTimeout? waitTimeSeconds?

Methods

handleMessage? handleMessageBatch? postReceiveMessageCallback? preReceiveMessageCallback?

Properties

queueUrl

queueUrl: string

The SQS queue URL.

OptionalalwaysAcknowledge

alwaysAcknowledge?: boolean

By default, the consumer will treat an empty object or array from either of the handlers as a acknowledgement of no messages and will not delete those messages as a result. Set this to true to always acknowledge all messages no matter the returned value.

Defaultvalue

false

OptionalattributeNames

attributeNames?: QueueAttributeName[]

List of queue attributes to retrieve, see AWS docs.

Defaultvalue

[]

OptionalauthenticationErrorTimeout

authenticationErrorTimeout?: number

The duration (in milliseconds) to wait before retrying after an authentication error.

Defaultvalue

10000

OptionalbatchSize

batchSize?: number

The number of messages to request from SQS when polling (default 1).

This cannot be higher than the AWS limit of 10.

Defaultvalue

1

OptionalextendedAWSErrors

extendedAWSErrors?: boolean

Set this to true if you want to receive additional information about the error that occurred from AWS, such as the response and metadata.

OptionalhandleMessageTimeout

handleMessageTimeout?: number

Time in ms to wait for handleMessage to process a message before timing out.

Emits timeout_error on timeout. By default, if handleMessage times out, the unprocessed message returns to the end of the queue.

OptionalheartbeatInterval

heartbeatInterval?: number

The interval (in seconds) between requests to extend the message visibility timeout.

On each heartbeat the visibility is extended by adding visibilityTimeout to the number of seconds since the start of the handler function.

This value must less than visibilityTimeout.

OptionalmessageAttributeNames

messageAttributeNames?: string[]

List of message attributes to retrieve (i.e. ['name', 'address']).

Defaultvalue

[]

OptionalmessageSystemAttributeNames

messageSystemAttributeNames?: MessageSystemAttributeName[]

A list of attributes that need to be returned along with each message.

Defaultvalue

[]

OptionalpollingCompleteWaitTimeMs

pollingCompleteWaitTimeMs?: number

If you want the stop action to wait for the final poll to complete and in-flight messages to be processed before emitting 'stopped' set this to the max amount of time to wait.

Defaultvalue

0

OptionalpollingWaitTimeMs

pollingWaitTimeMs?: number

The duration (in milliseconds) to wait before repolling the queue.

Defaultvalue

0

Optionalregion

region?: string

The AWS region.

Default Value

process.env.AWS_REGION || eu-west-1

OptionalshouldDeleteMessages

shouldDeleteMessages?: boolean

Default to true, if you don't want the package to delete messages from sqs set this to false.

Defaultvalue

true

Optionalsqs

sqs?: SQSClient

An optional SQS Client object to use if you need to configure the client manually.

OptionalterminateVisibilityTimeout

terminateVisibilityTimeout?: number | boolean

If true, sets the message visibility timeout to 0 after a processing_error. You can also specify a different timeout using a number.

Defaultvalue

false

OptionaluseQueueUrlAsEndpoint

useQueueUrlAsEndpoint?: boolean

Set this value to false to ignore the queueUrl and use the client's resolved endpoint, which may be a custom endpoint.

Default Value

true

OptionalvisibilityTimeout

visibilityTimeout?: number

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

OptionalwaitTimeSeconds

waitTimeSeconds?: number

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning.

Defaultvalue

20

Methods

OptionalhandleMessage

  • handleMessage(message): Promise<void | Message>

  • An async function (or function that returns a Promise) to be called whenever a message is received.

    In the case that you need to acknowledge the message, return an object containing the MessageId that you'd like to acknowledge.

    Parameters

    • message: Message

    Returns Promise<void | Message>

OptionalhandleMessageBatch

  • handleMessageBatch(messages): Promise<void | Message[]>

  • An async function (or function that returns a Promise) to be called whenever a batch of messages is received. Similar to handleMessage but will receive the list of messages, not each message individually.

    If both are set, handleMessageBatch overrides handleMessage.

    In the case that you need to ack only some of the messages, return an array with the successful messages only.

    Parameters

    • messages: Message[]

    Returns Promise<void | Message[]>

OptionalpostReceiveMessageCallback

  • postReceiveMessageCallback(): Promise<void>

  • An async function (or function that returns a Promise) to be called right after the SQS Client sends a receive message command.

    This function is usefull if SQS Client module exports have been modified, for example to add middlewares.

    Returns Promise<void>

OptionalpreReceiveMessageCallback

  • preReceiveMessageCallback(): Promise<void>

  • An async function (or function that returns a Promise) to be called right before the SQS Client sends a receive message command.

    This function is usefull if SQS Client module exports have been modified, for example to add middlewares.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods