effect 2.0.0-next.36 → 2.0.0-next.38

package/dist/declarations/src/Queue.d.ts

@@ -0,0 +1,496 @@
+/**
+ * @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";
+/**
+ * @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 models
+ */
+export interface Queue<A> extends Enqueue<A>, Dequeue<A>, Pipeable {
+}
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Enqueue<A> extends Queue.EnqueueVariance<A>, BaseQueue, Pipeable {
+    /**
+     * Places one value in the queue.
+     */
+    offer(value: A): Effect.Effect<never, never, 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<never, never, boolean>;
+}
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Dequeue<A> extends Queue.DequeueVariance<A>, BaseQueue, Pipeable {
+    /**
+     * 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.
+     */
+    take(): Effect.Effect<never, never, A>;
+    /**
+     * Takes all the values in the queue and returns the values. If the queue is
+     * empty returns an empty collection.
+     */
+    takeAll(): Effect.Effect<never, never, Chunk.Chunk<A>>;
+    /**
+     * Takes up to max number of values from the queue.
+     */
+    takeUpTo(max: number): Effect.Effect<never, never, 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<never, never, Chunk.Chunk<A>>;
+}
+/**
+ * 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.
+     */
+    size(): Effect.Effect<never, never, 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.
+     */
+    isFull(): Effect.Effect<never, never, boolean>;
+    /**
+     * Returns `true` if the `Queue` contains zero elements, `false` otherwise.
+     */
+    isEmpty(): Effect.Effect<never, never, boolean>;
+    /**
+     * Interrupts any fibers that are suspended on `offer` or `take`. Future calls
+     * to `offer*` and `take*` will be interrupted immediately.
+     */
+    shutdown(): Effect.Effect<never, never, void>;
+    /**
+     * Returns `true` if `shutdown` has been called, otherwise returns `false`.
+     */
+    isShutdown(): Effect.Effect<never, never, 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.
+     */
+    awaitShutdown(): Effect.Effect<never, never, void>;
+}
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Strategy<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.
+     */
+    shutdown(): Effect.Effect<never, never, 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<never, A>>, isShutdown: MutableRef.MutableRef<boolean>): Effect.Effect<never, never, boolean>;
+    /**
+     * 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<never, A>>): void;
+}
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface BackingQueue<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<A> {
+        readonly [EnqueueTypeId]: {
+            readonly _In: (_: A) => void;
+        };
+    }
+    /**
+     * @since 2.0.0
+     * @category models
+     */
+    interface DequeueVariance<A> {
+        readonly [DequeueTypeId]: {
+            readonly _Out: (_: never) => A;
+        };
+    }
+    /**
+     * @since 2.0.0
+     * @category models
+     */
+    interface StrategyVariance<A> {
+        readonly [QueueStrategyTypeId]: {
+            readonly _A: (_: never) => 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<never, never, 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<never, never, 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<never, never, 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<never, never, Queue<A>>;
+/**
+ * Creates a new unbounded `Queue`.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const unbounded: <A>() => Effect.Effect<never, never, 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<never, never, 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<never, never, 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<never, never, 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<never, never, 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<never, never, 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<never, never, void>;
+/**
+ * Places one value in the queue.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export declare const offer: {
+    <A>(value: A): (self: Enqueue<A>) => Effect.Effect<never, never, boolean>;
+    <A>(self: Enqueue<A>, value: A): Effect.Effect<never, never, boolean>;
+};
+/**
+ * Places one value in the queue.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export declare const unsafeOffer: {
+    <A>(value: A): (self: Enqueue<A>) => boolean;
+    <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: {
+    <A>(iterable: Iterable<A>): (self: Enqueue<A>) => Effect.Effect<never, never, boolean>;
+    <A>(self: Enqueue<A>, iterable: Iterable<A>): Effect.Effect<never, never, 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<never, never, 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<never, never, 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<never, never, Chunk.Chunk<A>>;
+/**
+ * Takes up to max number of values from the queue.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export declare const takeUpTo: {
+    (max: number): <A>(self: Dequeue<A>) => Effect.Effect<never, never, Chunk.Chunk<A>>;
+    <A>(self: Dequeue<A>, max: number): Effect.Effect<never, never, 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: {
+    (min: number, max: number): <A>(self: Dequeue<A>) => Effect.Effect<never, never, Chunk.Chunk<A>>;
+    <A>(self: Dequeue<A>, min: number, max: number): Effect.Effect<never, never, 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: {
+    (n: number): <A>(self: Dequeue<A>) => Effect.Effect<never, never, Chunk.Chunk<A>>;
+    <A>(self: Dequeue<A>, n: number): Effect.Effect<never, never, Chunk.Chunk<A>>;
+};
+//# sourceMappingURL=Queue.d.ts.map

package/dist/declarations/src/Queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue.d.ts","sourceRoot":"../../../src","sources":["Queue.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,mBAAe;AACrC,OAAO,KAAK,KAAK,QAAQ,sBAAkB;AAC3C,OAAO,KAAK,KAAK,MAAM,oBAAgB;AAEvC,OAAO,KAAK,KAAK,YAAY,0BAAsB;AACnD,OAAO,KAAK,KAAK,UAAU,wBAAoB;AAC/C,OAAO,KAAK,KAAK,MAAM,oBAAgB;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,sBAAkB;AAE1C;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,OAAO,MAA+B,CAAA;AAElE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,OAAO,MAA+B,CAAA;AAElE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAqC,CAAA;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ;CAWjE;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ;IAC/E;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAErD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;CACtE;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ;IAC/E;;;OAGG;IACH,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IAEtC;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAEtD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAElE;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CACnF;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAA;IAElB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAA;IAEnB;;;;OAIG;IACH,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAE3C;;;;OAIG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAEnC;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAE9C;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAE/C;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAE7C;;OAEG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAElD;;;;OAIG;IACH,aAAa,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC5D;;;OAGG;IACH,WAAW,IAAI,MAAM,CAAA;IAErB;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAE7C;;;;OAIG;IACH,aAAa,CACX,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,MAAM,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAC9D,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,GACzC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAEvC;;;OAGG;IACH,uBAAuB,CACrB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,MAAM,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAC7D,IAAI,CAAA;CACR;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B;;;OAGG;IACH,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC/C;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,IAAI,MAAM,CAAA;IAClB;;OAEG;IACH,MAAM,IAAI,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B;;;OAGG;IACH,UAAiB,eAAe,CAAC,CAAC;QAChC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE;YACxB,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAA;SAC7B,CAAA;KACF;IAED;;;OAGG;IACH,UAAiB,eAAe,CAAC,CAAC;QAChC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE;YACxB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAA;SAC/B,CAAA;KACF;IAED;;;OAGG;IACH,UAAiB,gBAAgB,CAAC,CAAC;QACjC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE;YAC9B,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAA;SAC7B,CAAA;KACF;CACF;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAoB,CAAA;AAE5E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAsB,CAAA;AAElF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAsB,CAAA;AAElF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAiC,CAAA;AAEvF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,CAA6B,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,CAA4B,CAAA;AAE7E;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAC9F,CAAA;AAEf;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAoB,CAAA;AAEhH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAqB,CAAA;AAElH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAoB,CAAA;AAEhH;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAsB,CAAA;AAE3F;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAA0B,CAAA;AAEvF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAiB,CAAA;AAE5G;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAoB,CAAA;AAEnH;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAmB,CAAA;AAEjH;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAC7E,CAAA;AAErB;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAC1E,CAAA;AAExB;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAqB,CAAA;AAElH;;;;;GAKG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACzE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;CACrD,CAAA;AAElB;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAA;IAC5C,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAA;CAClB,CAAA;AAExB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;CAC/D,CAAA;AAErB;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAiB,CAAA;AAEzG;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAiB,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAoB,CAAA;AAE7G;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACnF,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5D,CAAA;AAErB;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAChG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CACtE,CAAA;AAExB;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACjF,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAC7D,CAAA"}

package/dist/declarations/src/Random.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Chunk from "./Chunk.js";
+import type * as Effect from "./Effect.js";
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export declare const RandomTypeId: unique symbol;
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type RandomTypeId = typeof RandomTypeId;
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Random {
+    readonly [RandomTypeId]: RandomTypeId;
+    /**
+     * Returns the next numeric value from the pseudo-random number generator.
+     */
+    next(): Effect.Effect<never, never, number>;
+    /**
+     * Returns the next boolean value from the pseudo-random number generator.
+     */
+    nextBoolean(): Effect.Effect<never, never, boolean>;
+    /**
+     * Returns the next integer value from the pseudo-random number generator.
+     */
+    nextInt(): Effect.Effect<never, never, number>;
+    /**
+     * Returns the next numeric value in the specified range from the
+     * pseudo-random number generator.
+     */
+    nextRange(min: number, max: number): Effect.Effect<never, never, number>;
+    /**
+     * Returns the next integer value in the specified range from the
+     * pseudo-random number generator.
+     */
+    nextIntBetween(min: number, max: number): Effect.Effect<never, never, number>;
+    /**
+     * Uses the pseudo-random number generator to shuffle the specified iterable.
+     */
+    shuffle<A>(elements: Iterable<A>): Effect.Effect<never, never, Chunk.Chunk<A>>;
+}
+/**
+ * Returns the next numeric value from the pseudo-random number generator.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const next: Effect.Effect<never, never, number>;
+/**
+ * Returns the next integer value from the pseudo-random number generator.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const nextInt: Effect.Effect<never, never, number>;
+/**
+ * Returns the next boolean value from the pseudo-random number generator.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const nextBoolean: Effect.Effect<never, never, boolean>;
+/**
+ * Returns the next numeric value in the specified range from the
+ * pseudo-random number generator.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const nextRange: (min: number, max: number) => Effect.Effect<never, never, number>;
+/**
+ * Returns the next integer value in the specified range from the
+ * pseudo-random number generator.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const nextIntBetween: (min: number, max: number) => Effect.Effect<never, never, number>;
+/**
+ * Uses the pseudo-random number generator to shuffle the specified iterable.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const shuffle: <A>(elements: Iterable<A>) => Effect.Effect<never, never, Chunk.Chunk<A>>;
+/**
+ * Retreives the `Random` service from the context and uses it to run the
+ * specified workflow.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export declare const randomWith: <R, E, A>(f: (random: Random) => Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>;
+//# sourceMappingURL=Random.d.ts.map

package/dist/declarations/src/Random.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Random.d.ts","sourceRoot":"../../../src","sources":["Random.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,mBAAe;AACrC,OAAO,KAAK,KAAK,MAAM,oBAAgB;AAIvC;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,MAA8B,CAAA;AAEhE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA;AAE9C;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IACrC;;OAEG;IACH,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC3C;;OAEG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACnD;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC9C;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IACxE;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC7E;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAC/E;AAED;;;;;GAKG;AACH,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAwB,CAAA;AAE7E;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAA2B,CAAA;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAA+B,CAAA;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAA6B,CAAA;AAErH;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAC7D,CAAA;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CACrE,CAAA;AAEzB;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAC9E,CAAA"}