Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • QueueDrainer

Index

Constructors

constructor

  • Parameters

    • __namedParameters: object
      • batchSize: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
      • handleMessage: function
          • (message: Message): Promise<void>
          • Parameters

            • message: Message

            Returns Promise<void>

      • logger: Logger
      • queueUrl: string
      • shouldContinue: function
          • (): boolean
          • Returns boolean

      • sqs: SQS
      • stopWhenEmpty: boolean
      • waitTimeSeconds: number

    Returns QueueDrainer

Properties

Private batchSize

batchSize: BatchSize

Private handleMessage

handleMessage: MessageHandler

Private logger

logger: Logger

Private queueUrl

queueUrl: string

Private shouldContinue

shouldContinue: ShouldContinueFunction

Private sqs

sqs: SQS

Private stopWhenEmpty

stopWhenEmpty: boolean

Private waitTimeSeconds

waitTimeSeconds: number

Methods

Private deleteMessages

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

drain

  • drain(): Promise<void>

Private poll

  • poll(): Promise<Message[]>

Private processMessages

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

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