effect 4.0.0 → 4.0.2

package/dist/Chunk.js

@@ -7,6 +7,7 @@
  * creating, reading, slicing, mapping, filtering, sorting, zipping, combining,
  * and converting chunks to and from arrays and iterables.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as RA from "./Array.js";
@@ -48,6 +49,7 @@ const emptyArray = [];
  * eq(chunk1, chunk3) // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -170,6 +172,7 @@ const makeChunk = backing => {
  * Chunk.isChunk("string") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -188,6 +191,7 @@ const _empty = /*#__PURE__*/makeChunk({
  * Chunk.size(Chunk.empty()) // => 0
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -203,6 +207,7 @@ export const empty = () => _empty;
  * Chunk.toArray(Chunk.make(1, 2, 3, 4)) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -218,6 +223,7 @@ export const make = (...as) => fromNonEmptyArrayUnsafe(as);
  * Chunk.toArray(Chunk.of("hello")) // => ["hello"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -236,6 +242,7 @@ export const of = a => makeChunk({
  * Chunk.toArray(Chunk.fromIterable([1, 2, 3])) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -285,6 +292,7 @@ const toArray_ = self => toReadonlyArray(self).slice();
  * Chunk.toArray(Chunk.empty<number>()) // => []
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -335,6 +343,7 @@ const toReadonlyArray_ = self => {
  * Chunk.toReadonlyArray(Chunk.empty<number>()) // => []
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -384,6 +393,7 @@ const reverseChunk = self => {
  * Chunk.toArray(Chunk.reverse(chunk)) // => [3, 2, 1]
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -407,6 +417,7 @@ export const reverse = reverseChunk;
  * chunk.pipe(Chunk.get(2)) // => Option.some("c")
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -437,6 +448,7 @@ export const get = /*#__PURE__*/dual(2, (self, index) => index < 0 || index >= s
  * Chunk.toArray(chunk) // => [999, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -469,6 +481,7 @@ export const fromArrayUnsafe = self => self.length === 0 ? empty() : self.length
  * Chunk.isNonEmpty(chunk) // => true
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -499,6 +512,7 @@ export const fromNonEmptyArrayUnsafe = self => fromArrayUnsafe(self);
  * Option.isNone(Chunk.get(chunk, 10)) // => true
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -557,6 +571,7 @@ export const getUnsafe = /*#__PURE__*/dual(2, (self, index) => {
  * @see {@link prepend} for adding one element before the existing elements
  * @see {@link appendAll} for appending all elements from another chunk
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -577,6 +592,7 @@ export const append = /*#__PURE__*/dual(2, (self, a) => appendAll(self, of(a)));
  * Chunk.toArray(Chunk.prepend(emptyChunk, "first")) // => ["first"]
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -594,6 +610,7 @@ export const prepend = /*#__PURE__*/dual(2, (self, elem) => appendAll(of(elem),
  * Chunk.toArray(Chunk.take(chunk, 3)) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -650,6 +667,7 @@ export const take = /*#__PURE__*/dual(2, (self, _n) => {
  * Chunk.toArray(Chunk.drop(chunk, 2)) // => [3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -706,6 +724,7 @@ export const drop = /*#__PURE__*/dual(2, (self, _n) => {
  * Chunk.toArray(Chunk.dropRight(chunk, 2)) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -722,6 +741,7 @@ export const dropRight = /*#__PURE__*/dual(2, (self, n) => take(self, self.lengt
  * Chunk.toArray(Chunk.dropWhile(chunk, (n) => n < 3)) // => [3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -749,6 +769,7 @@ export const dropWhile = /*#__PURE__*/dual(2, (self, predicate) => {
  * ) // => ["a", "b", 1, 2]
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -776,6 +797,7 @@ export const prependAll = /*#__PURE__*/dual(2, (self, that) => appendAll(that, s
  * @see {@link prependAll} for concatenating chunks in the opposite order
  * @see {@link append} for adding a single element to the end
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -886,6 +908,7 @@ export const appendAll = /*#__PURE__*/dual(2, (self, that) => {
  * Chunk.toArray(evenIndexNumbers) // => [1]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -918,6 +941,7 @@ export const filterMap = /*#__PURE__*/dual(2, (self, f) => {
  * Chunk.toArray(numbers) // => [42, 100]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -942,6 +966,7 @@ export const filter = /*#__PURE__*/dual(2, (self, predicate) => fromArrayUnsafe(
  * })) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -969,6 +994,7 @@ export const filterMapWhile = /*#__PURE__*/dual(2, (self, f) => {
  * Chunk.toArray(Chunk.compact(chunk)) // => [1, 3]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1006,6 +1032,7 @@ export const compact = self => {
  * Chunk.toArray(indexed) // => [1, 3, 5]
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1052,6 +1079,7 @@ export const flatMap = /*#__PURE__*/dual(2, (self, f) => {
  * indexed // => ["Index 0: 1", "Index 1: 2", "Index 2: 3", "Index 3: 4"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -1080,6 +1108,7 @@ export const forEach = /*#__PURE__*/dual(2, (self, f) => toReadonlyArray(self).f
  * Chunk.toArray(Chunk.flatten(withEmpty)) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1120,6 +1149,7 @@ export const flatten = /*#__PURE__*/flatMap(identity);
  *
  * @see {@link split} for splitting into a target number of chunks instead of a fixed chunk size
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1166,6 +1196,7 @@ export const chunksOf = /*#__PURE__*/dual(2, (self, n) => {
  * Chunk.toArray(Chunk.intersection(chunk3, chunk4)) // => []
  * ```
  *
+ * @stability stable
  * @category set operations
  * @since 2.0.0
  */
@@ -1182,6 +1213,7 @@ export const intersection = /*#__PURE__*/dual(2, (self, that) => fromArrayUnsafe
  * Chunk.isEmpty(Chunk.make(1, 2, 3)) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1198,6 +1230,7 @@ export const isEmpty = self => self.length === 0;
  * Chunk.isNonEmpty(Chunk.make(1, 2, 3)) // => true
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1214,6 +1247,7 @@ export const isNonEmpty = self => self.length > 0;
  * Chunk.head(Chunk.make(1, 2, 3)) // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1245,6 +1279,7 @@ export const head = /*#__PURE__*/get(0);
  * Option.isNone(Chunk.head(Chunk.empty())) // => true
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -1267,6 +1302,7 @@ export const headUnsafe = self => getUnsafe(self, 0);
  * // Chunk.headNonEmpty(Chunk.empty()) // TypeScript error
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1283,6 +1319,7 @@ export const headNonEmpty = headUnsafe;
  * Chunk.last(Chunk.make(1, 2, 3)) // => Option.some(3)
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1314,6 +1351,7 @@ export const last = self => get(self, self.length - 1);
  * Option.isNone(Chunk.last(Chunk.empty())) // => true
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -1336,6 +1374,7 @@ export const lastUnsafe = self => getUnsafe(self, self.length - 1);
  * // Chunk.lastNonEmpty(Chunk.empty()) // TypeScript error
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.4.0
  */
@@ -1352,6 +1391,7 @@ export const lastNonEmpty = lastUnsafe;
  * Chunk.toArray(Chunk.map(Chunk.make(1, 2), (n) => n + 1)) // => [2, 3]
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1383,6 +1423,7 @@ export const map = /*#__PURE__*/dual(2, (self, f) => self.backing._tag === "ISin
  * Chunk.toArray(indexed) // => ["0: hello", "1: world", "2: effect"]
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1410,6 +1451,7 @@ export const mapAccum = /*#__PURE__*/dual(3, (self, s, f) => {
  * Chunk.toArray(fails) // => ["negative:-2"]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1450,6 +1492,7 @@ export const partition = /*#__PURE__*/dual(2, (self, f) => {
  * Chunk.toArray(noErrors) // => []
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1465,6 +1508,7 @@ export const separate = self => pipe(RA.separate(toReadonlyArray(self)), ([l, r]
  * Chunk.size(Chunk.make(1, 2, 3)) // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1488,6 +1532,7 @@ export const size = self => self.length;
  * Chunk.toArray(Chunk.sort(words, Order.String)) // => ["apple", "banana", "cherry"]
  * ```
  *
+ * @stability stable
  * @category sorting
  * @since 2.0.0
  */
@@ -1519,6 +1564,7 @@ export const sort = /*#__PURE__*/dual(2, (self, O) => fromArrayUnsafe(RA.sort(to
  * Chunk.toArray(Chunk.sortWith(words, (word) => word.length, Order.Number)) // => ["a", "ab", "abc"]
  * ```
  *
+ * @stability stable
  * @category sorting
  * @since 2.0.0
  */
@@ -1547,6 +1593,7 @@ export const sortWith = /*#__PURE__*/dual(3, (self, f, order) => sort(self, Orde
  * Chunk.toArray(empty2) // => []
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1580,6 +1627,7 @@ export const splitAt = /*#__PURE__*/dual(2, (self, n) => [take(self, n), drop(se
  * // while the second part may be empty
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1615,6 +1663,7 @@ export const splitNonEmptyAt = /*#__PURE__*/dual(2, (self, n) => {
  * Chunk.toArray(chunks3).map(Chunk.toArray) // => [[1, 2, 3, 4, 5, 6, 7, 8, 9]]
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1644,6 +1693,7 @@ export const split = /*#__PURE__*/dual(2, (self, n) => chunksOf(self, Math.ceil(
  * Chunk.toArray(allFromFirst) // => [1, 2, 3, 4, 5, 6]
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1675,6 +1725,7 @@ export const splitWhere = /*#__PURE__*/dual(2, (self, predicate) => {
  * Chunk.tail(Chunk.empty<number>()) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1697,6 +1748,7 @@ export const tail = self => self.length > 0 ? O.some(drop(self, 1)) : O.none();
  * // Chunk.tailNonEmpty(Chunk.empty()) // TypeScript error
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1720,6 +1772,7 @@ export const tailNonEmpty = self => drop(self, 1);
  * Chunk.toArray(Chunk.takeRight(chunk, 0)) // => []
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1743,6 +1796,7 @@ export const takeRight = /*#__PURE__*/dual(2, (self, n) => drop(self, self.lengt
  * Chunk.toArray(Chunk.takeWhile(small, (n) => n < 10)) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1775,6 +1829,7 @@ export const takeWhile = /*#__PURE__*/dual(2, (self, predicate) => {
  * Chunk.toArray(Chunk.union(withDupes1, withDupes2)) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category set operations
  * @since 2.0.0
  */
@@ -1800,6 +1855,7 @@ export const union = /*#__PURE__*/dual(2, (self, that) => fromArrayUnsafe(RA.uni
  * Chunk.toArray(Chunk.dedupe(unique)) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category deduplication
  * @since 2.0.0
  */
@@ -1820,6 +1876,7 @@ export const dedupe = self => fromArrayUnsafe(RA.dedupe(toReadonlyArray(self)));
  * Chunk.toArray(Chunk.dedupeAdjacent(mixed)) // => ["a", "b", "a"]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1852,6 +1909,7 @@ export const dedupeAdjacent = self => fromArrayUnsafe(RA.dedupeAdjacent(self));
  * Chunk.toArray(emptyStrs) // => []
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1877,6 +1935,7 @@ export const unzip = self => {
  * Chunk.toArray(Chunk.zipWith(short, long, (n, l) => [n, l])) // => [[1, "a"], [2, "b"]]
  * ```
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -1899,6 +1958,7 @@ export const zipWith = /*#__PURE__*/dual(3, (self, that, f) => fromArrayUnsafe(R
  * Chunk.toArray(Chunk.zip(short, long)) // => [[1, "a"], [2, "b"]]
  * ```
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -1921,6 +1981,7 @@ export const zip = /*#__PURE__*/dual(2, (self, that) => zipWith(self, that, (a,
  * Chunk.toArray(Chunk.remove(chunk, 10)) // => ["a", "b", "c", "d"]
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1944,6 +2005,7 @@ export const remove = /*#__PURE__*/dual(2, (self, i) => fromArrayUnsafe(RA.remov
  * chunk.pipe(Chunk.modify(-1, (n) => n * 10)) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1967,6 +2029,7 @@ export const modify = /*#__PURE__*/dual(3, (self, i, f) => pipe(RA.modify(toRead
  * chunk.pipe(Chunk.replace(-1, "Z")) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1987,6 +2050,7 @@ export const replace = /*#__PURE__*/dual(3, (self, i, b) => modify(self, i, () =
  * Chunk.toArray(Chunk.makeBy(5, (i) => i * 2)) // => [0, 2, 4, 6, 8]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2008,6 +2072,7 @@ export const makeBy = /*#__PURE__*/dual(2, (n, f) => fromIterable(RA.makeBy(n, f
  * Chunk.toArray(Chunk.range(1, 5)) // => [1, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2036,6 +2101,7 @@ export const range = (start, end) => start <= end ? makeBy(end - start + 1, i =>
  * Chunk.contains(Chunk.empty<number>(), 1) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2066,6 +2132,7 @@ export const contains = RA.contains;
  * containsCaseInsensitive(words, "grape") // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2094,6 +2161,7 @@ export const containsWith = RA.containsWith;
  * firstString // => Option.some("hello")
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2116,6 +2184,7 @@ export const findFirst = RA.findFirst;
  * Chunk.findFirstIndex(chunk, (n) => n % 2 === 0) // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2138,6 +2207,7 @@ export const findFirstIndex = /*#__PURE__*/dual(2, (self, predicate) => RA.findF
  * Chunk.findLast(chunk, (n) => n % 2 === 0) // => Option.some(4)
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2160,6 +2230,7 @@ export const findLast = /*#__PURE__*/dual(2, (self, predicate) => RA.findLast(to
  * Chunk.findLastIndex(chunk, (n) => n % 2 === 0) // => Option.some(3)
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2186,6 +2257,7 @@ export const findLastIndex = /*#__PURE__*/dual(2, (self, predicate) => RA.findLa
  * }
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -2218,6 +2290,7 @@ export const every = /*#__PURE__*/dual(2, (self, refinement) => {
  * Chunk.some(words, (word) => word.includes("ban")) // => true
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -2251,6 +2324,7 @@ export const some = /*#__PURE__*/dual(2, (self, predicate) => {
  * Chunk.join(Chunk.make("hello"), ", ") // => "hello"
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -2274,6 +2348,7 @@ export const join = /*#__PURE__*/dual(2, (self, sep) => toReadonlyArray(self).jo
  * Chunk.reduce(chunk, -Infinity, (acc, n) => Math.max(acc, n)) // => 5
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -2301,6 +2376,7 @@ export const reduce = RA.reduce;
  * Chunk.reduceRight(chunk, 0, (acc, n) => n - acc) // => -2
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -2332,6 +2408,7 @@ export const reduceRight = RA.reduceRight;
  * Chunk.toArray(caseInsensitive(words1, words2)) // => ["Banana", "Cherry"]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 3.2.0
  */
@@ -2360,6 +2437,7 @@ export const differenceWith = isEquivalent => {
  * Chunk.toArray(Chunk.difference(chunk1, Chunk.empty<number>())) // => [1, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 3.2.0
  */