import { CMR, CMRConstructorParams } from './CMR'; /** * Shim to correctly add a default provider_short_name to the input searchParams */ export declare const providerParams: ({ searchParams, provider, }: { searchParams?: URLSearchParams | undefined; provider: string; }) => URLSearchParams; export interface CMRSearchConceptQueueConstructorParams { cmrSettings: CMRConstructorParams; provider: string; type: string; searchParams?: URLSearchParams; format?: string; } /** * A class to efficiently list all of the concepts (collections/granules) from * CMR search, without loading them all into memory at once. Handles paging. * * @typicalname cmrSearchConceptQueue * * @example * const { CMRSearchConceptQueue } = require('@cumulus/cmr-client'); * * const cmrSearchConceptQueue = new CMRSearchConceptQueue({ * provider: 'my-provider', * clientId: 'my-clientId', * type: 'granule', * searchParams: {}, * format: 'json' * }); */ export declare class CMRSearchConceptQueue { type: string; params: URLSearchParams; format?: string; items: (T | null)[]; CMR: CMR; /** * The constructor for the CMRSearchConceptQueue class * * @param {Object} params * @param {Object} params.cmrSettings - the CMR settings for the requests - the provider, * clientId, and either launchpad token or EDL username and password * @param {string} params.type - the type of search 'granule' or 'collection' * @param {URLSearchParams} [params.searchParams={}] - the search parameters * @param {string} params.format - the result format */ constructor(params: CMRSearchConceptQueueConstructorParams); /** * View the next item in the queue * * This does not remove the object from the queue. When there are no more * items in the queue, returns 'null'. * */ peek(): Promise; /** * Remove the next item from the queue * * When there are no more items in the queue, returns `null`. */ shift(): Promise; /** * Query the CMR API to get the next batch of items * * @returns {Promise} resolves when the queue has been updated * @private */ fetchItems(): Promise; } //# sourceMappingURL=CMRSearchConceptQueue.d.ts.map