Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • QueueConfig

Implemented by

Index

Properties

Optional batchSize

batchSize: number

Specify a batch size in order to have your handler invoked with an array of items. If batchSize isn't specified, your handler will be invoked with only a single (non-array) queue item at a time.

Optional deleteImmediately

deleteImmediately: boolean

Item(s) from the queue will be deleted as soon as they're passed to the handler. Use this only if you plan on processing each item only once or have special logic within your handler function to deal with any failure cases.

Optional fifo

fifo: boolean

Create a FIFO queue in order to leverage their benefits (guaranteed order, deduplication, etc). Note that .fifo will be appended to the name of any FIFO queues if not included already.

see

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html

Optional handler

handler: QueueHandler

Not required in case the client is only creating and/or populating the queue.

Optional longPollingInterval

longPollingInterval: number

The number of seconds we'll wait for a message with each call to SQS.receiveMessage. Defaults to the maximum allowed value of 20 seconds.

Optional onFinish

onFinish: Function

Invoked whenever we poll the queue and it's empty.

queueName

queueName: string

Must be a valid SQS queue name, i.e. only composed of alphanumeric characters, hyphens (-), and/or underscores (_). The only exception is for the .fifo suffix on FIFO queues. Note that the entire queue name, even with a .fifo suffix, must still be 80 characters or less in length.

Optional sqs

sqs: SQS

A user-provided instance of AWS.SQS. If not provided, a default instance will be used which attempts to use the default profile of the credentials stored in ~/.aws/credentials and region us-west-2.

Optional visibilityTimeout

visibilityTimeout: number

The duration in seconds that a message will be 'invisible' to other queue consumers after it starts being processed by the initial consumer. Our default will be 600s (10 minutes).

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc