@cumulus/message/Queue.d.ts

Utilities for building and parsing Cumulus messages

import { Message } from '@cumulus/types';
declare type MessageWithQueueInfo = Message.CumulusMessage & {
    cumulus_meta: {
        queueUrl: string;
    };
};
/**
 * Get the queue URL from a workflow message.
 *
 * @param {MessageWithQueueInfo} message - A workflow message object
 * @returns {string} A queue URL
 *
 * @alias module:Queue
 */
export declare const getQueueUrl: (message: MessageWithQueueInfo) => string;
/**
 * Get the maximum executions for a queue.
 *
 * @param {Message.CumulusMessage} message - A workflow message object
 * @param {string} queueUrl - A queue URL
 * @returns {number} Count of the maximum executions for the queue
 * @throws {Error} if no maximum executions can be found
 *
 * @alias module:Queue
 */
export declare const getMaximumExecutions: (message: Message.CumulusMessage, queueUrl: string) => number;
/**
 * Determine if there is a queue and queue execution limit in the message.
 *
 * @param {MessageWithQueueInfo} message - A workflow message object
 * @returns {boolean} True if there is a queue and execution limit.
 *
 * @alias module:Queue
 */
export declare const hasQueueAndExecutionLimit: (message: MessageWithQueueInfo) => boolean;
export {};
//# sourceMappingURL=Queue.d.ts.map