@cumulus/message/Collections.d.ts

Utilities for building and parsing Cumulus messages

import { Message } from '@cumulus/types';
export declare const collectionIdSeparator = "___";
/**
 * Utility functions for generating collection information or parsing collection information
 * from a Cumulus message
 *
 * @module Collections
 *
 * @example
 * const Collections = require('@cumulus/message/Collections');
 */
declare type CollectionInfo = {
    name: string;
    version: string;
};
/**
 * Returns the collection ID.
 *
 * @param {string} name - collection name
 * @param {string} version - collection version
 * @returns {string} collectionId
 *
 * @alias module:Collections
 */
export declare const constructCollectionId: (name: string, version: string) => string;
/**
 * Returns the name and version of a collection based on
 * the collectionId used in elasticsearch indexing
 *
 * @param collectionId - collectionId used in elasticsearch index
 * @returns - name and version as object
 *
 * @alias module:Collections
 */
export declare const deconstructCollectionId: (collectionId: string) => {
    name: string;
    version: string;
};
/**
 * Get collection name and version from execution message.
 *
 * @param {Message.CumulusMessage} message - An execution message
 * @returns {CollectionInfo | undefined}
 *   Object with collection name and version or undefined
 *
 * @alias module:Collections
 */
export declare const getCollectionNameAndVersionFromMessage: (message: Message.CumulusMessage) => CollectionInfo | undefined;
/**
 * Get collection ID from execution message.
 *
 * @param {Message.CumulusMessage} message - An execution message
 * @returns {string | undefined} - A collection ID or undefined if
 *                                 message.meta.collection isn't
 *                                 present
 *
 * @alias module:Collections
 */
export declare const getCollectionIdFromMessage: (message: Message.CumulusMessage) => string | undefined;
export {};
//# sourceMappingURL=Collections.d.ts.map