@egodigital/egoose/lib/queues/index.d.ts

Helper classes and functions for Node.js 10 or later.

/**
 * This file is part of the @egodigital/egoose distribution.
 * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/)
 *
 * @egodigital/egoose is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * @egodigital/egoose is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
import PQueue, * as pQueue from 'p-queue';
import PriorityQueue from 'p-queue/dist/priority-queue';
/**
 * Options for 'CreateQueueOptions' function.
 */
export declare type CreateQueueOptions = pQueue.Options<PriorityQueue, pQueue.DefaultAddOptions>;
/**
 * Creates a new queue.
 *
 * @param {CreateQueueOptions} [opts] Custom options.
 *
 * @return {PQueue} The new queue.
 */
export declare function createQueue(opts?: CreateQueueOptions): PQueue;