Class SdkSqsGateway

Implements

SqsGateway

Index

Constructors

Methods

ChangeVisibility Delete GetAttributes Receive Send

Constructors

constructor

new SdkSqsGateway(client: SQSClient): SdkSqsGateway
Parameters
- client: SQSClient
Returns SdkSqsGateway
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:56

Methods

ChangeVisibility

ChangeVisibility(
    queueUrl: string,
    receiptHandle: string,
    seconds: number,
): Promise<boolean>
False when the receipt handle no longer owns an in-flight message.
Parameters
- queueUrl: string
- receiptHandle: string
- seconds: number
Returns Promise<boolean>
Implementation of SqsGateway.ChangeVisibility
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:97

Delete

Delete(queueUrl: string, receiptHandle: string): Promise<boolean>
False when the receipt handle is no longer valid.
Parameters
- queueUrl: string
- receiptHandle: string
Returns Promise<boolean>
Implementation of SqsGateway.Delete
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:102

GetAttributes

GetAttributes(queueUrl: string): Promise<Record<string, string>>
All queue attributes; null when the queue does not exist.
Parameters
- queueUrl: string
Returns Promise<Record<string, string>>
Implementation of SqsGateway.GetAttributes
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:107

Receive

Receive(request: SqsReceiveRequest): Promise<SqsReceivedMessage[]>
Returns [] when the signal aborts the long poll.
Parameters
- request: SqsReceiveRequest
Returns Promise<SqsReceivedMessage[]>
Implementation of SqsGateway.Receive
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:58

Send

Send(request: SqsSendRequest): Promise<string>
Returns the new SQS MessageId.
Parameters
- request: SqsSendRequest
Returns Promise<string>
Implementation of SqsGateway.Send
- Defined in packages/WorkQueue/aws/src/gateway/SdkSqsGateway.ts:78