Class AWSSQSService

class: AWSSQSService

support of AWS SQS Service

Hierarchy

AWSSQSService

Implements

SQSService

Index

Constructors

Properties

_endpoint _region SQS_ENDPOINT SQS_REGION

Methods

deleteMessage endpoint hello receiveMessage region sendMessage statistics

Constructors

constructor

new AWSSQSService(endpoint?: string, region?: string): AWSSQSService
default constructor.
Parameters
- Optional endpoint: string
- Optional region: string
Returns AWSSQSService
- Defined in src/cores/aws/aws-sqs-service.ts:77

Properties

`Protected` _endpoint

_endpoint: string

`Protected` _region

_region: string

`Static` SQS_ENDPOINT

SQS_ENDPOINT: string = 'MY_SQS_ENDPOINT'

`Static` SQS_REGION

SQS_REGION: string = 'MY_SQS_REGION'

Methods

deleteMessage

deleteMessage(handle: string): Promise<void>
delete message by id
Parameters
- handle: string
  
  handle-id to delete.
Returns Promise<void>
Implementation of SQSService.deleteMessage
- Defined in src/cores/aws/aws-sqs-service.ts:183

endpoint

endpoint(): string
Returns string
- Defined in src/cores/aws/aws-sqs-service.ts:90

hello

hello(): string
hello

Returns string
Implementation of SQSService.hello
- Defined in src/cores/aws/aws-sqs-service.ts:96

receiveMessage

receiveMessage(size?: number): Promise<{ list: SqsMessage[] }>
receive message by size.
Parameters
- size: number = 1
  
  (default 1) size of message
Returns Promise<{ list: SqsMessage[] }>
Implementation of SQSService.receiveMessage
- Defined in src/cores/aws/aws-sqs-service.ts:136

region

region(): string
Returns string
- Defined in src/cores/aws/aws-sqs-service.ts:87

sendMessage

sendMessage(data: any, attr?: SQSAttribute): Promise<string>
send message into SQS.
Parameters
- data: any
  
  object data to be json.
- Optional attr: SQSAttribute
  
  attribute set.
Returns Promise<string>
Implementation of SQSService.sendMessage
- Defined in src/cores/aws/aws-sqs-service.ts:104

statistics

statistics(): Promise<SqsStatistics>
statistics for the given type.

Returns Promise<SqsStatistics>
Implementation of SQSService.statistics
- Defined in src/cores/aws/aws-sqs-service.ts:205

Generated using TypeDoc