effect 2.0.0-next.37 → 2.0.0-next.38

package/dist/TQueue-5621ef6e.cjs.dev.js

@@ -0,0 +1,353 @@
+'use strict';
+
+var tQueue = require('./tQueue-565f8994.cjs.dev.js');
+
+/**
+ * @since 2.0.0
+ */
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const TDequeueTypeId = tQueue.TDequeueTypeId;
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const TEnqueueTypeId = tQueue.TEnqueueTypeId;
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * The base interface that all `TQueue`s must implement.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ */
+
+/**
+ * Returns `true` if the specified value is a `TQueue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTQueue = tQueue.isTQueue;
+
+/**
+ * Returns `true` if the specified value is a `TDequeue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTDequeue = tQueue.isTDequeue;
+
+/**
+ * Returns `true` if the specified value is a `TEnqueue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTEnqueue = tQueue.isTEnqueue;
+
+/**
+ * Waits until the queue is shutdown. The `STM` returned by this method will
+ * not resume until the queue has been shutdown. If the queue is already
+ * shutdown, the `STM` will resume right away.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const awaitShutdown = tQueue.awaitShutdown;
+
+/**
+ * Creates a bounded queue with the back pressure strategy. The queue will
+ * retain values until they have been taken, applying back pressure to
+ * offerors if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const bounded = tQueue.bounded;
+
+/**
+ * Returns the number of elements the queue can hold.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const capacity = tQueue.capacity;
+
+/**
+ * Creates a bounded queue with the dropping strategy. The queue will drop new
+ * values if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const dropping = tQueue.dropping;
+
+/**
+ * Returns `true` if the `TQueue` contains zero elements, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isEmpty = tQueue.isEmpty;
+
+/**
+ * Returns `true` if the `TQueue` contains at least one element, `false`
+ * otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isFull = tQueue.isFull;
+
+/**
+ * Returns `true` if `shutdown` has been called, otherwise returns `false`.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isShutdown = tQueue.isShutdown;
+
+/**
+ * Places one value in the queue.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const offer = tQueue.offer;
+
+/**
+ * For Bounded TQueue: 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 TQueue: Places all values in the queue and returns true.
+ *
+ * For Sliding TQueue: 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 TQueue: 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 mutations
+ */
+const offerAll = tQueue.offerAll;
+
+/**
+ * Views the next element in the queue without removing it, retrying if the
+ * queue is empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const peek = tQueue.peek;
+
+/**
+ * Views the next element in the queue without removing it, returning `None`
+ * if the queue is empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const peekOption = tQueue.peekOption;
+
+/**
+ * Takes a single element from the queue, returning `None` if the queue is
+ * empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const poll = tQueue.poll;
+
+/**
+ * Drops elements from the queue while they do not satisfy the predicate,
+ * taking and returning the first element that does satisfy the predicate.
+ * Retries if no elements satisfy the predicate.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const seek = tQueue.seek;
+
+/**
+ * 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 mutations
+ */
+const shutdown = tQueue.shutdown;
+
+/**
+ * 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
+ */
+const size = tQueue.size;
+
+/**
+ * Creates a bounded queue with the sliding strategy. The queue will add new
+ * values and drop old values if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const sliding = tQueue.sliding;
+
+/**
+ * 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 mutations
+ */
+const take = tQueue.take;
+
+/**
+ * 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 mutations
+ */
+const takeAll = tQueue.takeAll;
+
+/**
+ * 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,
+ * retries until at least the minimum number of elements have been collected.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeBetween = tQueue.takeBetween;
+
+/**
+ * Takes the specified number of elements from the queue. If there are fewer
+ * than the specified number of elements available, it retries until they
+ * become available.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeN = tQueue.takeN;
+
+/**
+ * Takes up to max number of values from the queue.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeUpTo = tQueue.takeUpTo;
+
+/**
+ * Creates an unbounded queue.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const unbounded = tQueue.unbounded;
+
+var TQueue = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  TDequeueTypeId: TDequeueTypeId,
+  TEnqueueTypeId: TEnqueueTypeId,
+  isTQueue: isTQueue,
+  isTDequeue: isTDequeue,
+  isTEnqueue: isTEnqueue,
+  awaitShutdown: awaitShutdown,
+  bounded: bounded,
+  capacity: capacity,
+  dropping: dropping,
+  isEmpty: isEmpty,
+  isFull: isFull,
+  isShutdown: isShutdown,
+  offer: offer,
+  offerAll: offerAll,
+  peek: peek,
+  peekOption: peekOption,
+  poll: poll,
+  seek: seek,
+  shutdown: shutdown,
+  size: size,
+  sliding: sliding,
+  take: take,
+  takeAll: takeAll,
+  takeBetween: takeBetween,
+  takeN: takeN,
+  takeUpTo: takeUpTo,
+  unbounded: unbounded
+});
+
+exports.TDequeueTypeId = TDequeueTypeId;
+exports.TEnqueueTypeId = TEnqueueTypeId;
+exports.TQueue = TQueue;
+exports.awaitShutdown = awaitShutdown;
+exports.bounded = bounded;
+exports.capacity = capacity;
+exports.dropping = dropping;
+exports.isEmpty = isEmpty;
+exports.isFull = isFull;
+exports.isShutdown = isShutdown;
+exports.isTDequeue = isTDequeue;
+exports.isTEnqueue = isTEnqueue;
+exports.isTQueue = isTQueue;
+exports.offer = offer;
+exports.offerAll = offerAll;
+exports.peek = peek;
+exports.peekOption = peekOption;
+exports.poll = poll;
+exports.seek = seek;
+exports.shutdown = shutdown;
+exports.size = size;
+exports.sliding = sliding;
+exports.take = take;
+exports.takeAll = takeAll;
+exports.takeBetween = takeBetween;
+exports.takeN = takeN;
+exports.takeUpTo = takeUpTo;
+exports.unbounded = unbounded;

package/dist/TQueue-67ccf55b.cjs.prod.js

@@ -0,0 +1,353 @@
+'use strict';
+
+var tQueue = require('./tQueue-4b66ca7b.cjs.prod.js');
+
+/**
+ * @since 2.0.0
+ */
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const TDequeueTypeId = tQueue.TDequeueTypeId;
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const TEnqueueTypeId = tQueue.TEnqueueTypeId;
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * The base interface that all `TQueue`s must implement.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ */
+
+/**
+ * Returns `true` if the specified value is a `TQueue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTQueue = tQueue.isTQueue;
+
+/**
+ * Returns `true` if the specified value is a `TDequeue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTDequeue = tQueue.isTDequeue;
+
+/**
+ * Returns `true` if the specified value is a `TEnqueue`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+const isTEnqueue = tQueue.isTEnqueue;
+
+/**
+ * Waits until the queue is shutdown. The `STM` returned by this method will
+ * not resume until the queue has been shutdown. If the queue is already
+ * shutdown, the `STM` will resume right away.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const awaitShutdown = tQueue.awaitShutdown;
+
+/**
+ * Creates a bounded queue with the back pressure strategy. The queue will
+ * retain values until they have been taken, applying back pressure to
+ * offerors if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const bounded = tQueue.bounded;
+
+/**
+ * Returns the number of elements the queue can hold.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const capacity = tQueue.capacity;
+
+/**
+ * Creates a bounded queue with the dropping strategy. The queue will drop new
+ * values if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const dropping = tQueue.dropping;
+
+/**
+ * Returns `true` if the `TQueue` contains zero elements, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isEmpty = tQueue.isEmpty;
+
+/**
+ * Returns `true` if the `TQueue` contains at least one element, `false`
+ * otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isFull = tQueue.isFull;
+
+/**
+ * Returns `true` if `shutdown` has been called, otherwise returns `false`.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const isShutdown = tQueue.isShutdown;
+
+/**
+ * Places one value in the queue.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const offer = tQueue.offer;
+
+/**
+ * For Bounded TQueue: 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 TQueue: Places all values in the queue and returns true.
+ *
+ * For Sliding TQueue: 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 TQueue: 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 mutations
+ */
+const offerAll = tQueue.offerAll;
+
+/**
+ * Views the next element in the queue without removing it, retrying if the
+ * queue is empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const peek = tQueue.peek;
+
+/**
+ * Views the next element in the queue without removing it, returning `None`
+ * if the queue is empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const peekOption = tQueue.peekOption;
+
+/**
+ * Takes a single element from the queue, returning `None` if the queue is
+ * empty.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const poll = tQueue.poll;
+
+/**
+ * Drops elements from the queue while they do not satisfy the predicate,
+ * taking and returning the first element that does satisfy the predicate.
+ * Retries if no elements satisfy the predicate.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const seek = tQueue.seek;
+
+/**
+ * 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 mutations
+ */
+const shutdown = tQueue.shutdown;
+
+/**
+ * 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
+ */
+const size = tQueue.size;
+
+/**
+ * Creates a bounded queue with the sliding strategy. The queue will add new
+ * values and drop old values if the queue is at capacity.
+ *
+ * For best performance use capacities that are powers of two.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const sliding = tQueue.sliding;
+
+/**
+ * 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 mutations
+ */
+const take = tQueue.take;
+
+/**
+ * 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 mutations
+ */
+const takeAll = tQueue.takeAll;
+
+/**
+ * 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,
+ * retries until at least the minimum number of elements have been collected.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeBetween = tQueue.takeBetween;
+
+/**
+ * Takes the specified number of elements from the queue. If there are fewer
+ * than the specified number of elements available, it retries until they
+ * become available.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeN = tQueue.takeN;
+
+/**
+ * Takes up to max number of values from the queue.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+const takeUpTo = tQueue.takeUpTo;
+
+/**
+ * Creates an unbounded queue.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const unbounded = tQueue.unbounded;
+
+var TQueue = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  TDequeueTypeId: TDequeueTypeId,
+  TEnqueueTypeId: TEnqueueTypeId,
+  isTQueue: isTQueue,
+  isTDequeue: isTDequeue,
+  isTEnqueue: isTEnqueue,
+  awaitShutdown: awaitShutdown,
+  bounded: bounded,
+  capacity: capacity,
+  dropping: dropping,
+  isEmpty: isEmpty,
+  isFull: isFull,
+  isShutdown: isShutdown,
+  offer: offer,
+  offerAll: offerAll,
+  peek: peek,
+  peekOption: peekOption,
+  poll: poll,
+  seek: seek,
+  shutdown: shutdown,
+  size: size,
+  sliding: sliding,
+  take: take,
+  takeAll: takeAll,
+  takeBetween: takeBetween,
+  takeN: takeN,
+  takeUpTo: takeUpTo,
+  unbounded: unbounded
+});
+
+exports.TDequeueTypeId = TDequeueTypeId;
+exports.TEnqueueTypeId = TEnqueueTypeId;
+exports.TQueue = TQueue;
+exports.awaitShutdown = awaitShutdown;
+exports.bounded = bounded;
+exports.capacity = capacity;
+exports.dropping = dropping;
+exports.isEmpty = isEmpty;
+exports.isFull = isFull;
+exports.isShutdown = isShutdown;
+exports.isTDequeue = isTDequeue;
+exports.isTEnqueue = isTEnqueue;
+exports.isTQueue = isTQueue;
+exports.offer = offer;
+exports.offerAll = offerAll;
+exports.peek = peek;
+exports.peekOption = peekOption;
+exports.poll = poll;
+exports.seek = seek;
+exports.shutdown = shutdown;
+exports.size = size;
+exports.sliding = sliding;
+exports.take = take;
+exports.takeAll = takeAll;
+exports.takeBetween = takeBetween;
+exports.takeN = takeN;
+exports.takeUpTo = takeUpTo;
+exports.unbounded = unbounded;