/** * @since 2.0.0 */ import type * as Chunk from "./Chunk.js"; import type * as Option from "./Option.js"; import type * as Order from "./Order.js"; import type { Predicate } from "./Predicate.js"; import type * as STM from "./STM.js"; import type * as Types from "./Types.js"; /** * @since 2.0.0 * @category symbols */ export declare const TPriorityQueueTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type TPriorityQueueTypeId = typeof TPriorityQueueTypeId; /** * A `TPriorityQueue` contains values of type `A` that an `Order` is defined * on. Unlike a `TQueue`, `take` returns the highest priority value (the value * that is first in the specified ordering) as opposed to the first value * offered to the queue. The ordering that elements with the same priority will * be taken from the queue is not guaranteed. * * @since 2.0.0 * @category models */ export interface TPriorityQueue extends TPriorityQueue.Variance { } /** * @since 2.0.0 */ export declare namespace TPriorityQueue { /** * @since 2.0.0 * @category models */ interface Variance { readonly [TPriorityQueueTypeId]: { readonly _A: Types.Invariant; }; } } /** * Constructs a new empty `TPriorityQueue` with the specified `Order`. * * @since 2.0.0 * @category constructors */ export declare const empty: (order: Order.Order) => STM.STM>; /** * Creates a new `TPriorityQueue` from an iterable collection of values. * * @since 2.0.0 * @category constructors */ export declare const fromIterable: (order: Order.Order) => (iterable: Iterable) => STM.STM>; /** * Checks whether the queue is empty. * * @since 2.0.0 * @category getters */ export declare const isEmpty: (self: TPriorityQueue) => STM.STM; /** * Checks whether the queue is not empty. * * @since 2.0.0 * @category getters */ export declare const isNonEmpty: (self: TPriorityQueue) => STM.STM; /** * Makes a new `TPriorityQueue` that is initialized with specified values. * * @since 2.0.0 * @category constructors */ export declare const make: (order: Order.Order) => (...elements: Array) => STM.STM>; /** * Offers the specified value to the queue. * * @since 2.0.0 * @category mutations */ export declare const offer: { /** * Offers the specified value to the queue. * * @since 2.0.0 * @category mutations */ (value: A): (self: TPriorityQueue) => STM.STM; /** * Offers the specified value to the queue. * * @since 2.0.0 * @category mutations */ (self: TPriorityQueue, value: A): STM.STM; }; /** * Offers all of the elements in the specified collection to the queue. * * @since 2.0.0 * @category mutations */ export declare const offerAll: { /** * Offers all of the elements in the specified collection to the queue. * * @since 2.0.0 * @category mutations */ (values: Iterable): (self: TPriorityQueue) => STM.STM; /** * Offers all of the elements in the specified collection to the queue. * * @since 2.0.0 * @category mutations */ (self: TPriorityQueue, values: Iterable): STM.STM; }; /** * Peeks at the first value in the queue without removing it, retrying until a * value is in the queue. * * @since 2.0.0 * @category getters */ export declare const peek: (self: TPriorityQueue) => STM.STM; /** * Peeks at the first value in the queue without removing it, returning `None` * if there is not a value in the queue. * * @since 2.0.0 * @category getters */ export declare const peekOption: (self: TPriorityQueue) => STM.STM>; /** * Removes all elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ export declare const removeIf: { /** * Removes all elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ (predicate: Predicate): (self: TPriorityQueue) => STM.STM; /** * Removes all elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ (self: TPriorityQueue, predicate: Predicate): STM.STM; }; /** * Retains only elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ export declare const retainIf: { /** * Retains only elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ (predicate: Predicate): (self: TPriorityQueue) => STM.STM; /** * Retains only elements from the queue matching the specified predicate. * * @since 2.0.0 * @category getters */ (self: TPriorityQueue, predicate: Predicate): STM.STM; }; /** * Returns the size of the queue. * * @since 2.0.0 * @category getters */ export declare const size: (self: TPriorityQueue) => STM.STM; /** * Takes a value from the queue, retrying until a value is in the queue. * * @since 2.0.0 * @category mutations */ export declare const take: (self: TPriorityQueue) => STM.STM; /** * Takes all values from the queue. * * @since 2.0.0 * @category mutations */ export declare const takeAll: (self: TPriorityQueue) => STM.STM>; /** * Takes a value from the queue, returning `None` if there is not a value in * the queue. * * @since 2.0.0 * @category mutations */ export declare const takeOption: (self: TPriorityQueue) => STM.STM>; /** * Takes up to the specified maximum number of elements from the queue. * * @since 2.0.0 * @category mutations */ export declare const takeUpTo: { /** * Takes up to the specified maximum number of elements from the queue. * * @since 2.0.0 * @category mutations */ (n: number): (self: TPriorityQueue) => STM.STM>; /** * Takes up to the specified maximum number of elements from the queue. * * @since 2.0.0 * @category mutations */ (self: TPriorityQueue, n: number): STM.STM>; }; /** * Collects all values into a `Chunk`. * * @since 2.0.0 * @category destructors */ export declare const toChunk: (self: TPriorityQueue) => STM.STM>; /** * Collects all values into an array. * * @since 2.0.0 * @category destructors */ export declare const toArray: (self: TPriorityQueue) => STM.STM>; //# sourceMappingURL=TPriorityQueue.d.ts.map