UNPKG

1.6 kBTypeScriptView Raw
1import { SQS } from 'aws-sdk';
2import { SendMessageBatchRequestEntry } from 'aws-sdk/clients/sqs';
3export declare const sqs: SQS;
4export interface EnsureQueueResult {
5 queueName: string;
6 queueUrl: string;
7 queueArn: string;
8 topicArns: string[];
9 topicNames: string[];
10}
11/**
12 * http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html
13 * http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html
14 * @param {string} queueName [description]
15 * @param {string[] = []} topicNames [description]
16 * @return {Promise<EnsureQueueResult>} [description]
17 */
18export declare function ensureQueue(queueName: string, topicNames?: string[]): Promise<EnsureQueueResult>;
19/**
20 * [receiveMessages description]
21 * @param {string} queueUrl [description]
22 * @param {SQS.Message[]) => void} callback [description]
23 * @return {Promise<void>} [description]
24 */
25export declare function receiveMessages(queueUrl: string, callback: (messages: SQS.Message[]) => void): Promise<void>;
26/**
27 * [deleteMessage description]
28 * @param {string} queueUrl [description]
29 * @param {string} receiptHandle [description]
30 * @return {Promise<void>} [description]
31 */
32export declare function deleteMessage(queueUrl: string, receiptHandle: string): Promise<void>;
33/**
34 * Publishes a number of messages to the SQS queue
35 * @param queueUrl
36 * @param entries
37 */
38export declare function sendMessageBatch(queueUrl: string, entries: SendMessageBatchRequestEntry[]): Promise<void>;