Lorem Ipsum MCP Server

/** * @since 2.0.0 */ import type * as Chunk from "./Chunk.js"; import type * as Deferred from "./Deferred.js"; import type * as Effect from "./Effect.js"; import type * as MutableQueue from "./MutableQueue.js"; import type * as MutableRef from "./MutableRef.js"; import type * as Option from "./Option.js"; import type { Pipeable } from "./Pipeable.js"; import type * as Types from "./Types.js"; import type * as Unify from "./Unify.js"; /** * @since 2.0.0 * @category symbols */ export declare const EnqueueTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type EnqueueTypeId = typeof EnqueueTypeId; /** * @since 2.0.0 * @category symbols */ export declare const DequeueTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type DequeueTypeId = typeof DequeueTypeId; /** * @since 2.0.0 * @category symbols */ export declare const QueueStrategyTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type QueueStrategyTypeId = typeof QueueStrategyTypeId; /** * @since 2.0.0 * @category symbols */ export declare const BackingQueueTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type BackingQueueTypeId = typeof BackingQueueTypeId; /** * @since 2.0.0 * @category models */ export interface Queue<in out A> extends Enqueue<A>, Dequeue<A> { readonly [Unify.typeSymbol]?: unknown; readonly [Unify.unifySymbol]?: QueueUnify<this>; readonly [Unify.ignoreSymbol]?: QueueUnifyIgnore; } /** * @category models * @since 3.8.0 */ export interface QueueUnify<A extends { [Unify.typeSymbol]?: any; }> extends DequeueUnify<A> { Queue?: () => Extract<A[Unify.typeSymbol], Queue<any>>; } /** * @category models * @since 3.8.0 */ export interface QueueUnifyIgnore extends DequeueUnifyIgnore { Dequeue?: true; } /** * @since 2.0.0 * @category models */ export interface Enqueue<in A> extends Queue.EnqueueVariance<A>, BaseQueue, Pipeable { /** * Places one value in the queue. */ offer(value: A): Effect.Effect<boolean>; /** * Places one value in the queue when possible without needing the fiber runtime. */ unsafeOffer(value: A): boolean; /** * For Bounded Queue: uses the `BackPressure` Strategy, places the values in * the queue and always returns true. If the queue has reached capacity, then * the fiber performing the `offerAll` will be suspended until there is room * in the queue. * * For Unbounded Queue: Places all values in the queue and returns true. * * For Sliding Queue: uses `Sliding` Strategy If there is room in the queue, * it places the values otherwise it removes the old elements and enqueues the * new ones. Always returns true. * * For Dropping Queue: uses `Dropping` Strategy, It places the values in the * queue but if there is no room it will not enqueue them and return false. */ offerAll(iterable: Iterable<A>): Effect.Effect<boolean>; } /** * @since 2.0.0 * @category models */ export interface Dequeue<out A> extends Effect.Effect<A>, Queue.DequeueVariance<A>, BaseQueue { /** * Takes the oldest value in the queue. If the queue is empty, this will return * a computation that resumes when an item has been added to the queue. */ readonly take: Effect.Effect<A>; /** * Takes all the values in the queue and returns the values. If the queue is * empty returns an empty collection. */ readonly takeAll: Effect.Effect<Chunk.Chunk<A>>; /** * Takes up to max number of values from the queue. */ takeUpTo(max: number): Effect.Effect<Chunk.Chunk<A>>; /** * Takes a number of elements from the queue between the specified minimum and * maximum. If there are fewer than the minimum number of elements available, * suspends until at least the minimum number of elements have been collected. */ takeBetween(min: number, max: number): Effect.Effect<Chunk.Chunk<A>>; readonly [Unify.typeSymbol]?: unknown; readonly [Unify.unifySymbol]?: DequeueUnify<this>; readonly [Unify.ignoreSymbol]?: DequeueUnifyIgnore; } /** * @category models * @since 3.8.0 */ export interface DequeueUnify<A extends { [Unify.typeSymbol]?: any; }> extends Effect.EffectUnify<A> { Dequeue?: () => A[Unify.typeSymbol] extends Dequeue<infer A0> | infer _ ? Dequeue<A0> : never; } /** * @category models * @since 3.8.0 */ export interface DequeueUnifyIgnore extends Effect.EffectUnifyIgnore { Effect?: true; } /** * The base interface that all `Queue`s must implement. * * @since 2.0.0 * @category models */ export interface BaseQueue { /** * Returns the number of elements the queue can hold. */ capacity(): number; /** * Returns false if shutdown has been called. */ isActive(): boolean; /** * Retrieves the size of the queue, which is equal to the number of elements * in the queue. This may be negative if fibers are suspended waiting for * elements to be added to the queue. */ readonly size: Effect.Effect<number>; /** * Retrieves the size of the queue, which is equal to the number of elements * in the queue. This may be negative if fibers are suspended waiting for * elements to be added to the queue. Returns None if shutdown has been called */ unsafeSize(): Option.Option<number>; /** * Returns `true` if the `Queue` contains at least one element, `false` * otherwise. */ readonly isFull: Effect.Effect<boolean>; /** * Returns `true` if the `Queue` contains zero elements, `false` otherwise. */ readonly isEmpty: Effect.Effect<boolean>; /** * Interrupts any fibers that are suspended on `offer` or `take`. Future calls * to `offer*` and `take*` will be interrupted immediately. */ readonly shutdown: Effect.Effect<void>; /** * Returns `true` if `shutdown` has been called, otherwise returns `false`. */ readonly isShutdown: Effect.Effect<boolean>; /** * Waits until the queue is shutdown. The `Effect` returned by this method will * not resume until the queue has been shutdown. If the queue is already * shutdown, the `Effect` will resume right away. */ readonly awaitShutdown: Effect.Effect<void>; } /** * @since 2.0.0 * @category models */ export interface Strategy<in out A> extends Queue.StrategyVariance<A> { /** * Returns the number of surplus values that were unable to be added to the * `Queue` */ surplusSize(): number; /** * Determines how the `Queue.Strategy` should shut down when the `Queue` is * shut down. */ readonly shutdown: Effect.Effect<void>; /** * Determines the behavior of the `Queue.Strategy` when there are surplus * values that could not be added to the `Queue` following an `offer` * operation. */ handleSurplus(iterable: Iterable<A>, queue: BackingQueue<A>, takers: MutableQueue.MutableQueue<Deferred.Deferred<A>>, isShutdown: MutableRef.MutableRef<boolean>): Effect.Effect<boolean>; /** * It is called when the backing queue is empty but there are some * takers that can be completed */ onCompleteTakersWithEmptyQueue(takers: MutableQueue.MutableQueue<Deferred.Deferred<A>>): void; /** * Determines the behavior of the `Queue.Strategy` when the `Queue` has empty * slots following a `take` operation. */ unsafeOnQueueEmptySpace(queue: BackingQueue<A>, takers: MutableQueue.MutableQueue<Deferred.Deferred<A>>): void; } /** * @since 2.0.0 * @category models */ export interface BackingQueue<in out A> extends Queue.BackingQueueVariance<A> { /** * Dequeues an element from the queue. * Returns either an element from the queue, or the `def` param. */ poll<Def>(def: Def): A | Def; /** * Dequeues up to `limit` elements from the queue. */ pollUpTo(limit: number): Chunk.Chunk<A>; /** * Enqueues a collection of values into the queue. * * Returns a `Chunk` of the values that were **not** able to be enqueued. */ offerAll(elements: Iterable<A>): Chunk.Chunk<A>; /** * Offers an element to the queue. * * Returns whether the enqueue was successful or not. */ offer(element: A): boolean; /** * The **maximum** number of elements that a queue can hold. * * **Note**: unbounded queues can still implement this interface with * `capacity = Infinity`. */ capacity(): number; /** * Returns the number of elements currently in the queue */ length(): number; } /** * @since 2.0.0 */ export declare namespace Queue { /** * @since 2.0.0 * @category models */ interface EnqueueVariance<in A> { readonly [EnqueueTypeId]: { readonly _In: Types.Contravariant<A>; }; } /** * @since 2.0.0 * @category models */ interface DequeueVariance<out A> { readonly [DequeueTypeId]: { readonly _Out: Types.Covariant<A>; }; } /** * @since 2.0.0 * @category models */ interface StrategyVariance<in out A> { readonly [QueueStrategyTypeId]: { readonly _A: Types.Invariant<A>; }; } /** * @since 2.0.0 * @category models */ interface BackingQueueVariance<in out A> { readonly [BackingQueueTypeId]: { readonly _A: Types.Invariant<A>; }; } } /** * Returns `true` if the specified value is a `Queue`, `false` otherwise. * * @since 2.0.0 * @category refinements */ export declare const isQueue: (u: unknown) => u is Queue<unknown>; /** * Returns `true` if the specified value is a `Dequeue`, `false` otherwise. * * @since 2.0.0 * @category refinements */ export declare const isDequeue: (u: unknown) => u is Dequeue<unknown>; /** * Returns `true` if the specified value is a `Enqueue`, `false` otherwise. * * @since 2.0.0 * @category refinements */ export declare const isEnqueue: (u: unknown) => u is Enqueue<unknown>; /** * @since 2.0.0 * @category strategies */ export declare const backPressureStrategy: <A>() => Strategy<A>; /** * @since 2.0.0 * @category strategies */ export declare const droppingStrategy: <A>() => Strategy<A>; /** * @since 2.0.0 * @category strategies */ export declare const slidingStrategy: <A>() => Strategy<A>; /** * @since 2.0.0 * @category constructors */ export declare const make: <A>(queue: BackingQueue<A>, strategy: Strategy<A>) => Effect.Effect<Queue<A>>; /** * Makes a new bounded `Queue`. When the capacity of the queue is reached, any * additional calls to `offer` will be suspended until there is more room in * the queue. * * **Note**: When possible use only power of 2 capacities; this will provide * better performance by utilising an optimised version of the underlying * `RingBuffer`. * * @since 2.0.0 * @category constructors */ export declare const bounded: <A>(requestedCapacity: number) => Effect.Effect<Queue<A>>; /** * Makes a new bounded `Queue` with the dropping strategy. * * When the capacity of the queue is reached, new elements will be dropped and the * old elements will remain. * * **Note**: When possible use only power of 2 capacities; this will provide * better performance by utilising an optimised version of the underlying * `RingBuffer`. * * @since 2.0.0 * @category constructors */ export declare const dropping: <A>(requestedCapacity: number) => Effect.Effect<Queue<A>>; /** * Makes a new bounded `Queue` with the sliding strategy. * * When the capacity of the queue is reached, new elements will be added and the * old elements will be dropped. * * **Note**: When possible use only power of 2 capacities; this will provide * better performance by utilising an optimised version of the underlying * `RingBuffer`. * * @since 2.0.0 * @category constructors */ export declare const sliding: <A>(requestedCapacity: number) => Effect.Effect<Queue<A>>; /** * Creates a new unbounded `Queue`. * * @since 2.0.0 * @category constructors */ export declare const unbounded: <A>() => Effect.Effect<Queue<A>>; /** * Returns the number of elements the queue can hold. * * @since 2.0.0 * @category getters */ export declare const capacity: <A>(self: Dequeue<A> | Enqueue<A>) => number; /** * Retrieves the size of the queue, which is equal to the number of elements * in the queue. This may be negative if fibers are suspended waiting for * elements to be added to the queue. * * @since 2.0.0 * @category getters */ export declare const size: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<number>; /** * Returns `true` if the `Queue` contains zero elements, `false` otherwise. * * @since 2.0.0 * @category getters */ export declare const isEmpty: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<boolean>; /** * Returns `true` if the `Queue` contains at least one element, `false` * otherwise. * * @since 2.0.0 * @category getters */ export declare const isFull: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<boolean>; /** * Returns `true` if `shutdown` has been called, otherwise returns `false`. * * @since 2.0.0 * @category getters */ export declare const isShutdown: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<boolean>; /** * Waits until the queue is shutdown. The `Effect` returned by this method will * not resume until the queue has been shutdown. If the queue is already * shutdown, the `Effect` will resume right away. * * @since 2.0.0 * @category utils */ export declare const awaitShutdown: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<void>; /** * Interrupts any fibers that are suspended on `offer` or `take`. Future calls * to `offer*` and `take*` will be interrupted immediately. * * @since 2.0.0 * @category utils */ export declare const shutdown: <A>(self: Dequeue<A> | Enqueue<A>) => Effect.Effect<void>; /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ export declare const offer: { /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ <A>(value: A): (self: Enqueue<A>) => Effect.Effect<boolean>; /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ <A>(self: Enqueue<A>, value: A): Effect.Effect<boolean>; }; /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ export declare const unsafeOffer: { /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ <A>(value: A): (self: Enqueue<A>) => boolean; /** * Places one value in the queue. * * @since 2.0.0 * @category utils */ <A>(self: Enqueue<A>, value: A): boolean; }; /** * For Bounded Queue: uses the `BackPressure` Strategy, places the values in * the queue and always returns true. If the queue has reached capacity, then * the fiber performing the `offerAll` will be suspended until there is room * in the queue. * * For Unbounded Queue: Places all values in the queue and returns true. * * For Sliding Queue: uses `Sliding` Strategy If there is room in the queue, * it places the values otherwise it removes the old elements and enqueues the * new ones. Always returns true. * * For Dropping Queue: uses `Dropping` Strategy, It places the values in the * queue but if there is no room it will not enqueue them and return false. * * @since 2.0.0 * @category utils */ export declare const offerAll: { /** * For Bounded Queue: uses the `BackPressure` Strategy, places the values in * the queue and always returns true. If the queue has reached capacity, then * the fiber performing the `offerAll` will be suspended until there is room * in the queue. * * For Unbounded Queue: Places all values in the queue and returns true. * * For Sliding Queue: uses `Sliding` Strategy If there is room in the queue, * it places the values otherwise it removes the old elements and enqueues the * new ones. Always returns true. * * For Dropping Queue: uses `Dropping` Strategy, It places the values in the * queue but if there is no room it will not enqueue them and return false. * * @since 2.0.0 * @category utils */ <A>(iterable: Iterable<A>): (self: Enqueue<A>) => Effect.Effect<boolean>; /** * For Bounded Queue: uses the `BackPressure` Strategy, places the values in * the queue and always returns true. If the queue has reached capacity, then * the fiber performing the `offerAll` will be suspended until there is room * in the queue. * * For Unbounded Queue: Places all values in the queue and returns true. * * For Sliding Queue: uses `Sliding` Strategy If there is room in the queue, * it places the values otherwise it removes the old elements and enqueues the * new ones. Always returns true. * * For Dropping Queue: uses `Dropping` Strategy, It places the values in the * queue but if there is no room it will not enqueue them and return false. * * @since 2.0.0 * @category utils */ <A>(self: Enqueue<A>, iterable: Iterable<A>): Effect.Effect<boolean>; }; /** * Returns the first value in the `Queue` as a `Some<A>`, or `None` if the queue * is empty. * * @since 2.0.0 * @category utils */ export declare const poll: <A>(self: Dequeue<A>) => Effect.Effect<Option.Option<A>>; /** * Takes the oldest value in the queue. If the queue is empty, this will return * a computation that resumes when an item has been added to the queue. * * @since 2.0.0 * @category utils */ export declare const take: <A>(self: Dequeue<A>) => Effect.Effect<A>; /** * Takes all the values in the queue and returns the values. If the queue is * empty returns an empty collection. * * @since 2.0.0 * @category utils */ export declare const takeAll: <A>(self: Dequeue<A>) => Effect.Effect<Chunk.Chunk<A>>; /** * Takes up to max number of values from the queue. * * @since 2.0.0 * @category utils */ export declare const takeUpTo: { /** * Takes up to max number of values from the queue. * * @since 2.0.0 * @category utils */ (max: number): <A>(self: Dequeue<A>) => Effect.Effect<Chunk.Chunk<A>>; /** * Takes up to max number of values from the queue. * * @since 2.0.0 * @category utils */ <A>(self: Dequeue<A>, max: number): Effect.Effect<Chunk.Chunk<A>>; }; /** * Takes a number of elements from the queue between the specified minimum and * maximum. If there are fewer than the minimum number of elements available, * suspends until at least the minimum number of elements have been collected. * * @since 2.0.0 * @category utils */ export declare const takeBetween: { /** * Takes a number of elements from the queue between the specified minimum and * maximum. If there are fewer than the minimum number of elements available, * suspends until at least the minimum number of elements have been collected. * * @since 2.0.0 * @category utils */ (min: number, max: number): <A>(self: Dequeue<A>) => Effect.Effect<Chunk.Chunk<A>>; /** * Takes a number of elements from the queue between the specified minimum and * maximum. If there are fewer than the minimum number of elements available, * suspends until at least the minimum number of elements have been collected. * * @since 2.0.0 * @category utils */ <A>(self: Dequeue<A>, min: number, max: number): Effect.Effect<Chunk.Chunk<A>>; }; /** * Takes the specified number of elements from the queue. If there are fewer * than the specified number of elements available, it suspends until they * become available. * * @since 2.0.0 * @category utils */ export declare const takeN: { /** * Takes the specified number of elements from the queue. If there are fewer * than the specified number of elements available, it suspends until they * become available. * * @since 2.0.0 * @category utils */ (n: number): <A>(self: Dequeue<A>) => Effect.Effect<Chunk.Chunk<A>>; /** * Takes the specified number of elements from the queue. If there are fewer * than the specified number of elements available, it suspends until they * become available. * * @since 2.0.0 * @category utils */ <A>(self: Dequeue<A>, n: number): Effect.Effect<Chunk.Chunk<A>>; }; //# sourceMappingURL=Queue.d.ts.map