| /** | |
| * Stores many values in an immutable ordered collection. | |
| * | |
| * A `Chunk<A>` is useful when you need to build or transform collections | |
| * without changing the original collection. It is designed for efficient | |
| * append, prepend, and concatenation. This module includes helpers for | |
| * creating, reading, slicing, mapping, filtering, sorting, zipping, combining, | |
| * and converting chunks to and from arrays and iterables. | |
| * | |
| * @since 2.0.0 | |
| */ | |
| import * as RA from "./Array.js"; | |
| import * as Equal from "./Equal.js"; | |
| import * as Equivalence from "./Equivalence.js"; | |
| import { format } from "./Formatter.js"; | |
| import { dual, identity, pipe } from "./Function.js"; | |
| import * as Hash from "./Hash.js"; | |
| import { NodeInspectSymbol, toJson } from "./Inspectable.js"; | |
| import * as O from "./Option.js"; | |
| import * as Order from "./Order.js"; | |
| import { pipeArguments } from "./Pipeable.js"; | |
| import { hasProperty } from "./Predicate.js"; | |
| import * as R from "./Result.js"; | |
| const TypeId = "~effect/collections/Chunk"; | |
| function copy(src, srcPos, dest, destPos, len) { | |
| for (let i = srcPos; i < Math.min(src.length, srcPos + len); i++) { | |
| dest[destPos + i - srcPos] = src[i]; | |
| } | |
| return dest; | |
| } | |
| const emptyArray = []; | |
| /** | |
| * Creates an `Equivalence` for chunks that compares chunk lengths and then | |
| * compares corresponding elements with the provided element equivalence. | |
| * | |
| * **Example** (Comparing chunks for equivalence) | |
| * | |
| * ```ts | |
| * import { Chunk, Equivalence } from "effect" | |
| * | |
| * const chunk1 = Chunk.make(1, 2, 3) | |
| * const chunk2 = Chunk.make(1, 2, 3) | |
| * const chunk3 = Chunk.make(1, 2, 4) | |
| * | |
| * const eq = Chunk.makeEquivalence(Equivalence.strictEqual<number>()) | |
| * console.log(eq(chunk1, chunk2)) // true | |
| * console.log(eq(chunk1, chunk3)) // false | |
| * ``` | |
| * | |
| * @category instances | |
| * @since 4.0.0 | |
| */ | |
| export const makeEquivalence = isEquivalent => Equivalence.make((self, that) => self.length === that.length && toReadonlyArray(self).every((value, i) => isEquivalent(value, getUnsafe(that, i)))); | |
| const _equivalence = /*#__PURE__*/makeEquivalence(Equal.equals); | |
| const ChunkProto = { | |
| [TypeId]: { | |
| _A: _ => _ | |
| }, | |
| toString() { | |
| return `Chunk(${format(toReadonlyArray(this))})`; | |
| }, | |
| toJSON() { | |
| return { | |
| _id: "Chunk", | |
| values: toJson(toReadonlyArray(this)) | |
| }; | |
| }, | |
| [NodeInspectSymbol]() { | |
| return this.toJSON(); | |
| }, | |
| [Equal.symbol](that) { | |
| return isChunk(that) && _equivalence(this, that); | |
| }, | |
| [Hash.symbol]() { | |
| return Hash.array(toReadonlyArray(this)); | |
| }, | |
| [Symbol.iterator]() { | |
| switch (this.backing._tag) { | |
| case "IArray": | |
| { | |
| return this.backing.array[Symbol.iterator](); | |
| } | |
| case "IEmpty": | |
| { | |
| return emptyArray[Symbol.iterator](); | |
| } | |
| default: | |
| { | |
| return toReadonlyArray(this)[Symbol.iterator](); | |
| } | |
| } | |
| }, | |
| pipe() { | |
| return pipeArguments(this, arguments); | |
| } | |
| }; | |
| const makeChunk = backing => { | |
| const chunk = Object.create(ChunkProto); | |
| chunk.backing = backing; | |
| switch (backing._tag) { | |
| case "IEmpty": | |
| { | |
| chunk.length = 0; | |
| chunk.depth = 0; | |
| chunk.left = chunk; | |
| chunk.right = chunk; | |
| break; | |
| } | |
| case "IConcat": | |
| { | |
| chunk.length = backing.left.length + backing.right.length; | |
| chunk.depth = 1 + Math.max(backing.left.depth, backing.right.depth); | |
| chunk.left = backing.left; | |
| chunk.right = backing.right; | |
| break; | |
| } | |
| case "IArray": | |
| { | |
| chunk.length = backing.array.length; | |
| chunk.depth = 0; | |
| chunk.left = _empty; | |
| chunk.right = _empty; | |
| break; | |
| } | |
| case "ISingleton": | |
| { | |
| chunk.length = 1; | |
| chunk.depth = 0; | |
| chunk.left = _empty; | |
| chunk.right = _empty; | |
| break; | |
| } | |
| case "ISlice": | |
| { | |
| chunk.length = backing.length; | |
| chunk.depth = backing.chunk.depth + 1; | |
| chunk.left = _empty; | |
| chunk.right = _empty; | |
| break; | |
| } | |
| } | |
| return chunk; | |
| }; | |
| /** | |
| * Checks whether `u` is a `Chunk<unknown>` | |
| * | |
| * **Example** (Checking for chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const array = [1, 2, 3] | |
| * | |
| * console.log(Chunk.isChunk(chunk)) // true | |
| * console.log(Chunk.isChunk(array)) // false | |
| * console.log(Chunk.isChunk("string")) // false | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const isChunk = u => hasProperty(u, TypeId); | |
| const _empty = /*#__PURE__*/makeChunk({ | |
| _tag: "IEmpty" | |
| }); | |
| /** | |
| * Creates an empty `Chunk`. | |
| * | |
| * **Example** (Creating an empty chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const emptyChunk = Chunk.empty() | |
| * console.log(Chunk.size(emptyChunk)) // 0 | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const empty = () => _empty; | |
| /** | |
| * Builds a `NonEmptyChunk` from an non-empty collection of elements. | |
| * | |
| * **Example** (Creating a non-empty chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.toArray(chunk)) // [1, 2, 3, 4] | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const make = (...as) => fromNonEmptyArrayUnsafe(as); | |
| /** | |
| * Builds a `NonEmptyChunk` from a single element. | |
| * | |
| * **Example** (Creating a single-element chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.of("hello") | |
| * console.log(Chunk.toArray(chunk)) // ["hello"] | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const of = a => makeChunk({ | |
| _tag: "ISingleton", | |
| a | |
| }); | |
| /** | |
| * Creates a new `Chunk` from an iterable collection of values. | |
| * | |
| * **Example** (Creating chunks from iterables) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.fromIterable([1, 2, 3]) | |
| * console.log(Chunk.toArray(chunk)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const fromIterable = self => isChunk(self) ? self : fromArrayUnsafe(RA.fromIterable(self)); | |
| const copyToArray = (self, array, initial) => { | |
| switch (self.backing._tag) { | |
| case "IArray": | |
| { | |
| copy(self.backing.array, 0, array, initial, self.length); | |
| break; | |
| } | |
| case "IConcat": | |
| { | |
| copyToArray(self.left, array, initial); | |
| copyToArray(self.right, array, initial + self.left.length); | |
| break; | |
| } | |
| case "ISingleton": | |
| { | |
| array[initial] = self.backing.a; | |
| break; | |
| } | |
| case "ISlice": | |
| { | |
| let i = 0; | |
| let j = initial; | |
| while (i < self.length) { | |
| array[j] = getUnsafe(self, i); | |
| i += 1; | |
| j += 1; | |
| } | |
| break; | |
| } | |
| } | |
| }; | |
| const toArray_ = self => toReadonlyArray(self).slice(); | |
| /** | |
| * Converts a `Chunk` into an `Array`. If the provided `Chunk` is non-empty | |
| * (`NonEmptyChunk`), the function will return a `NonEmptyArray`, ensuring the | |
| * non-empty property is preserved. | |
| * | |
| * **Example** (Converting chunks to mutable arrays) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const array = Chunk.toArray(chunk) | |
| * console.log(array) // [1, 2, 3] | |
| * console.log(Array.isArray(array)) // true | |
| * | |
| * // With empty chunk | |
| * const emptyChunk = Chunk.empty<number>() | |
| * console.log(Chunk.toArray(emptyChunk)) // [] | |
| * ``` | |
| * | |
| * @category converting | |
| * @since 2.0.0 | |
| */ | |
| export const toArray = toArray_; | |
| const toReadonlyArray_ = self => { | |
| switch (self.backing._tag) { | |
| case "IEmpty": | |
| { | |
| return emptyArray; | |
| } | |
| case "IArray": | |
| { | |
| return self.backing.array; | |
| } | |
| default: | |
| { | |
| const arr = new Array(self.length); | |
| copyToArray(self, arr, 0); | |
| self.backing = { | |
| _tag: "IArray", | |
| array: arr | |
| }; | |
| self.left = _empty; | |
| self.right = _empty; | |
| self.depth = 0; | |
| return arr; | |
| } | |
| } | |
| }; | |
| /** | |
| * Converts a `Chunk` into a `ReadonlyArray`. If the provided `Chunk` is | |
| * non-empty (`NonEmptyChunk`), the function will return a | |
| * `NonEmptyReadonlyArray`, ensuring the non-empty property is preserved. | |
| * | |
| * **Example** (Converting chunks to readonly arrays) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const readonlyArray = Chunk.toReadonlyArray(chunk) | |
| * console.log(readonlyArray) // [1, 2, 3] | |
| * | |
| * // The result is read-only, modifications would cause TypeScript errors | |
| * // readonlyArray[0] = 10 // TypeScript error | |
| * | |
| * // With empty chunk | |
| * const emptyChunk = Chunk.empty<number>() | |
| * console.log(Chunk.toReadonlyArray(emptyChunk)) // [] | |
| * ``` | |
| * | |
| * @category converting | |
| * @since 2.0.0 | |
| */ | |
| export const toReadonlyArray = toReadonlyArray_; | |
| const reverseChunk = self => { | |
| switch (self.backing._tag) { | |
| case "IEmpty": | |
| case "ISingleton": | |
| return self; | |
| case "IArray": | |
| { | |
| return makeChunk({ | |
| _tag: "IArray", | |
| array: RA.reverse(self.backing.array) | |
| }); | |
| } | |
| case "IConcat": | |
| { | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: reverse(self.backing.right), | |
| right: reverse(self.backing.left) | |
| }); | |
| } | |
| case "ISlice": | |
| return fromArrayUnsafe(RA.reverse(toReadonlyArray(self))); | |
| } | |
| }; | |
| /** | |
| * Reverses the order of elements in a `Chunk`. | |
| * | |
| * **When to use** | |
| * | |
| * Use to read or process chunk elements in reverse order. | |
| * | |
| * **Details** | |
| * | |
| * If the input chunk is a `NonEmptyChunk`, the reversed chunk is also a | |
| * `NonEmptyChunk`. | |
| * | |
| * **Example** (Reversing chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const result = Chunk.reverse(chunk) | |
| * | |
| * console.log(Chunk.toArray(result)) // [3, 2, 1] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const reverse = reverseChunk; | |
| /** | |
| * Gets the value at an index in a `Chunk` safely, returning `None` when the index is | |
| * out of bounds. | |
| * | |
| * **Example** (Accessing elements safely) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make("a", "b", "c", "d") | |
| * | |
| * console.log(Chunk.get(chunk, 1)) // Option.some("b") | |
| * console.log(Chunk.get(chunk, 10)) // Option.none() | |
| * console.log(Chunk.get(chunk, -1)) // Option.none() | |
| * | |
| * // Using pipe syntax | |
| * const result = chunk.pipe(Chunk.get(2)) | |
| * console.log(result) // Option.some("c") | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const get = /*#__PURE__*/dual(2, (self, index) => index < 0 || index >= self.length ? O.none() : O.some(getUnsafe(self, index))); | |
| /** | |
| * Wraps an array into a chunk without copying. | |
| * | |
| * **When to use** | |
| * | |
| * Use when the input array can be shared with the resulting `Chunk` and avoiding | |
| * a copy matters. | |
| * | |
| * **Gotchas** | |
| * | |
| * Mutating the source array after wrapping can mutate the resulting `Chunk`. | |
| * | |
| * **Example** (Creating chunks without copying arrays) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const array = [1, 2, 3, 4, 5] | |
| * const chunk = Chunk.fromArrayUnsafe(array) | |
| * console.log(Chunk.toArray(chunk)) // [1, 2, 3, 4, 5] | |
| * | |
| * // Warning: Since this doesn't copy the array, mutations affect the chunk | |
| * array[0] = 999 | |
| * console.log(Chunk.toArray(chunk)) // [999, 2, 3, 4, 5] | |
| * ``` | |
| * | |
| * @category unsafe | |
| * @since 4.0.0 | |
| */ | |
| export const fromArrayUnsafe = self => self.length === 0 ? empty() : self.length === 1 ? of(self[0]) : makeChunk({ | |
| _tag: "IArray", | |
| array: self | |
| }); | |
| /** | |
| * Wraps a non-empty array into a non-empty chunk without copying. | |
| * | |
| * **When to use** | |
| * | |
| * Use when the input array is already known to be non-empty, can be shared with | |
| * the resulting `Chunk`, and avoiding a copy matters. | |
| * | |
| * **Gotchas** | |
| * | |
| * Mutating the source array after wrapping can mutate the resulting `Chunk`. | |
| * | |
| * **Example** (Creating non-empty chunks without copying arrays) | |
| * | |
| * ```ts | |
| * import { Array, Chunk } from "effect" | |
| * | |
| * const nonEmptyArray = Array.make(1, 2, 3, 4, 5) | |
| * const chunk = Chunk.fromNonEmptyArrayUnsafe(nonEmptyArray) | |
| * console.log(Chunk.toArray(chunk)) // [1, 2, 3, 4, 5] | |
| * | |
| * // The result is guaranteed to be non-empty | |
| * console.log(Chunk.isNonEmpty(chunk)) // true | |
| * ``` | |
| * | |
| * @category unsafe | |
| * @since 4.0.0 | |
| */ | |
| export const fromNonEmptyArrayUnsafe = self => fromArrayUnsafe(self); | |
| /** | |
| * Gets an element at the specified index without returning an `Option`. | |
| * | |
| * **When to use** | |
| * | |
| * Use when reading from a `Chunk` at an index known to be in bounds and direct | |
| * element access is preferred over handling `Option.none`. | |
| * | |
| * **Gotchas** | |
| * | |
| * Throws if the index is out of bounds. | |
| * | |
| * **Example** (Accessing elements unsafely) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make("a", "b", "c", "d") | |
| * | |
| * console.log(Chunk.getUnsafe(chunk, 1)) // "b" | |
| * console.log(Chunk.getUnsafe(chunk, 3)) // "d" | |
| * | |
| * // Use Chunk.get when the index may be out of bounds | |
| * console.log(Option.isNone(Chunk.get(chunk, 10))) // true | |
| * ``` | |
| * | |
| * @category unsafe | |
| * @since 4.0.0 | |
| */ | |
| export const getUnsafe = /*#__PURE__*/dual(2, (self, index) => { | |
| const i = Math.floor(index); | |
| switch (self.backing._tag) { | |
| case "IEmpty": | |
| { | |
| throw new Error(`Index out of bounds: ${i}`); | |
| } | |
| case "ISingleton": | |
| { | |
| if (index !== 0) { | |
| throw new Error(`Index out of bounds: ${i}`); | |
| } | |
| return self.backing.a; | |
| } | |
| case "IArray": | |
| { | |
| if (i >= self.length || i < 0) { | |
| throw new Error(`Index out of bounds: ${i}`); | |
| } | |
| return self.backing.array[i]; | |
| } | |
| case "IConcat": | |
| { | |
| return i < self.left.length ? getUnsafe(self.left, i) : getUnsafe(self.right, i - self.left.length); | |
| } | |
| case "ISlice": | |
| { | |
| return getUnsafe(self.backing.chunk, i + self.backing.offset); | |
| } | |
| } | |
| }); | |
| /** | |
| * Appends the specified element to the end of the `Chunk`. | |
| * | |
| * **When to use** | |
| * | |
| * Use to add one element after the existing chunk elements and return a | |
| * `NonEmptyChunk`. | |
| * | |
| * **Example** (Appending an element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const newChunk = Chunk.append(chunk, 4) | |
| * console.log(Chunk.toArray(newChunk)) // [1, 2, 3, 4] | |
| * | |
| * // Appending to empty chunk | |
| * const emptyChunk = Chunk.empty<number>() | |
| * const singleElement = Chunk.append(emptyChunk, 42) | |
| * console.log(Chunk.toArray(singleElement)) // [42] | |
| * ``` | |
| * | |
| * @see {@link prepend} for adding one element before the existing elements | |
| * @see {@link appendAll} for appending all elements from another chunk | |
| * | |
| * @category combining | |
| * @since 2.0.0 | |
| */ | |
| export const append = /*#__PURE__*/dual(2, (self, a) => appendAll(self, of(a))); | |
| /** | |
| * Prepends an element to the front of a `Chunk`, creating a new `NonEmptyChunk`. | |
| * | |
| * **Example** (Prepending an element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(2, 3, 4) | |
| * const newChunk = Chunk.prepend(chunk, 1) | |
| * console.log(Chunk.toArray(newChunk)) // [1, 2, 3, 4] | |
| * | |
| * // Prepending to empty chunk | |
| * const emptyChunk = Chunk.empty<string>() | |
| * const singleElement = Chunk.prepend(emptyChunk, "first") | |
| * console.log(Chunk.toArray(singleElement)) // ["first"] | |
| * ``` | |
| * | |
| * @category combining | |
| * @since 2.0.0 | |
| */ | |
| export const prepend = /*#__PURE__*/dual(2, (self, elem) => appendAll(of(elem), self)); | |
| /** | |
| * Takes the first up to `n` elements from the chunk. | |
| * | |
| * **Example** (Taking elements from the start) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.take(chunk, 3) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const take = /*#__PURE__*/dual(2, (self, n) => { | |
| if (n <= 0) { | |
| return _empty; | |
| } else if (n >= self.length) { | |
| return self; | |
| } else { | |
| switch (self.backing._tag) { | |
| case "ISlice": | |
| { | |
| return makeChunk({ | |
| _tag: "ISlice", | |
| chunk: self.backing.chunk, | |
| length: n, | |
| offset: self.backing.offset | |
| }); | |
| } | |
| case "IConcat": | |
| { | |
| if (n > self.left.length) { | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: self.left, | |
| right: take(self.right, n - self.left.length) | |
| }); | |
| } | |
| return take(self.left, n); | |
| } | |
| default: | |
| { | |
| return makeChunk({ | |
| _tag: "ISlice", | |
| chunk: self, | |
| offset: 0, | |
| length: n | |
| }); | |
| } | |
| } | |
| } | |
| }); | |
| /** | |
| * Drops the first up to `n` elements from the chunk. | |
| * | |
| * **Example** (Dropping elements from the start) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.drop(chunk, 2) | |
| * console.log(Chunk.toArray(result)) // [3, 4, 5] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const drop = /*#__PURE__*/dual(2, (self, n) => { | |
| if (n <= 0) { | |
| return self; | |
| } else if (n >= self.length) { | |
| return _empty; | |
| } else { | |
| switch (self.backing._tag) { | |
| case "ISlice": | |
| { | |
| return makeChunk({ | |
| _tag: "ISlice", | |
| chunk: self.backing.chunk, | |
| offset: self.backing.offset + n, | |
| length: self.backing.length - n | |
| }); | |
| } | |
| case "IConcat": | |
| { | |
| if (n > self.left.length) { | |
| return drop(self.right, n - self.left.length); | |
| } | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: drop(self.left, n), | |
| right: self.right | |
| }); | |
| } | |
| default: | |
| { | |
| return makeChunk({ | |
| _tag: "ISlice", | |
| chunk: self, | |
| offset: n, | |
| length: self.length - n | |
| }); | |
| } | |
| } | |
| } | |
| }); | |
| /** | |
| * Drops the last `n` elements. | |
| * | |
| * **Example** (Dropping elements from the end) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.dropRight(chunk, 2) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const dropRight = /*#__PURE__*/dual(2, (self, n) => take(self, Math.max(0, self.length - n))); | |
| /** | |
| * Drops all elements so long as the predicate returns true. | |
| * | |
| * **Example** (Dropping elements while a predicate matches) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.dropWhile(chunk, (n) => n < 3) | |
| * console.log(Chunk.toArray(result)) // [3, 4, 5] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const dropWhile = /*#__PURE__*/dual(2, (self, predicate) => { | |
| const arr = toReadonlyArray(self); | |
| const len = arr.length; | |
| let i = 0; | |
| while (i < len && predicate(arr[i])) { | |
| i++; | |
| } | |
| return drop(self, i); | |
| }); | |
| /** | |
| * Prepends the specified prefix chunk to the beginning of the specified chunk. | |
| * If either chunk is non-empty, the result is also a non-empty chunk. | |
| * | |
| * **Example** (Prepending all elements) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const result = Chunk.make(1, 2).pipe( | |
| * Chunk.prependAll(Chunk.make("a", "b")), | |
| * Chunk.toArray | |
| * ) | |
| * | |
| * console.log(result) | |
| * // [ "a", "b", 1, 2 ] | |
| * ``` | |
| * | |
| * @category combining | |
| * @since 2.0.0 | |
| */ | |
| export const prependAll = /*#__PURE__*/dual(2, (self, that) => appendAll(that, self)); | |
| /** | |
| * Concatenates two chunks, combining their elements. | |
| * If either chunk is non-empty, the result is also a non-empty chunk. | |
| * | |
| * **When to use** | |
| * | |
| * Use to concatenate two chunks when the second chunk's elements should come | |
| * after the first. | |
| * | |
| * **Example** (Appending all elements) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const result = Chunk.make(1, 2).pipe( | |
| * Chunk.appendAll(Chunk.make("a", "b")), | |
| * Chunk.toArray | |
| * ) | |
| * | |
| * console.log(result) | |
| * // [ 1, 2, "a", "b" ] | |
| * ``` | |
| * | |
| * @see {@link prependAll} for concatenating chunks in the opposite order | |
| * @see {@link append} for adding a single element to the end | |
| * | |
| * @category combining | |
| * @since 2.0.0 | |
| */ | |
| export const appendAll = /*#__PURE__*/dual(2, (self, that) => { | |
| if (self.backing._tag === "IEmpty") { | |
| return that; | |
| } | |
| if (that.backing._tag === "IEmpty") { | |
| return self; | |
| } | |
| const diff = that.depth - self.depth; | |
| if (Math.abs(diff) <= 1) { | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: self, | |
| right: that | |
| }); | |
| } else if (diff < -1) { | |
| if (self.left.depth >= self.right.depth) { | |
| const nr = appendAll(self.right, that); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: self.left, | |
| right: nr | |
| }); | |
| } else { | |
| const nrr = appendAll(self.right.right, that); | |
| if (nrr.depth === self.depth - 3) { | |
| const nr = makeChunk({ | |
| _tag: "IConcat", | |
| left: self.right.left, | |
| right: nrr | |
| }); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: self.left, | |
| right: nr | |
| }); | |
| } else { | |
| const nl = makeChunk({ | |
| _tag: "IConcat", | |
| left: self.left, | |
| right: self.right.left | |
| }); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: nl, | |
| right: nrr | |
| }); | |
| } | |
| } | |
| } else { | |
| if (that.right.depth >= that.left.depth) { | |
| const nl = appendAll(self, that.left); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: nl, | |
| right: that.right | |
| }); | |
| } else { | |
| const nll = appendAll(self, that.left.left); | |
| if (nll.depth === that.depth - 3) { | |
| const nl = makeChunk({ | |
| _tag: "IConcat", | |
| left: nll, | |
| right: that.left.right | |
| }); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: nl, | |
| right: that.right | |
| }); | |
| } else { | |
| const nr = makeChunk({ | |
| _tag: "IConcat", | |
| left: that.left.right, | |
| right: that.right | |
| }); | |
| return makeChunk({ | |
| _tag: "IConcat", | |
| left: nll, | |
| right: nr | |
| }); | |
| } | |
| } | |
| } | |
| }); | |
| /** | |
| * Returns a filtered and mapped subset of the elements. | |
| * | |
| * **Example** (Filtering and mapping values) | |
| * | |
| * ```ts | |
| * import { Chunk, Result } from "effect" | |
| * | |
| * const chunk = Chunk.make("1", "2", "hello", "3", "world") | |
| * const numbers = Chunk.filterMap(chunk, (str) => { | |
| * const num = parseInt(str) | |
| * return isNaN(num) ? Result.failVoid : Result.succeed(num) | |
| * }) | |
| * console.log(Chunk.toArray(numbers)) // [1, 2, 3] | |
| * | |
| * // With index parameter | |
| * const evenIndexNumbers = Chunk.filterMap(chunk, (str, i) => { | |
| * const num = parseInt(str) | |
| * return isNaN(num) || i % 2 !== 0 ? Result.failVoid : Result.succeed(num) | |
| * }) | |
| * console.log(Chunk.toArray(evenIndexNumbers)) // [1] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const filterMap = /*#__PURE__*/dual(2, (self, f) => { | |
| const as = RA.fromIterable(self); | |
| const out = []; | |
| for (let i = 0; i < as.length; i++) { | |
| const result = f(as[i], i); | |
| if (R.isSuccess(result)) { | |
| out.push(result.success); | |
| } | |
| } | |
| return fromArrayUnsafe(out); | |
| }); | |
| /** | |
| * Returns a filtered subset of the elements. | |
| * | |
| * **Example** (Filtering values) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6) | |
| * const evenNumbers = Chunk.filter(chunk, (n) => n % 2 === 0) | |
| * console.log(Chunk.toArray(evenNumbers)) // [2, 4, 6] | |
| * | |
| * // With refinement | |
| * const mixed = Chunk.make("hello", 42, "world", 100) | |
| * const numbers = Chunk.filter(mixed, (x): x is number => typeof x === "number") | |
| * console.log(Chunk.toArray(numbers)) // [42, 100] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const filter = /*#__PURE__*/dual(2, (self, predicate) => fromArrayUnsafe(RA.filter(self, predicate))); | |
| /** | |
| * Transforms all elements of the chunk for as long as the specified function succeeds. | |
| * | |
| * **Example** (Filtering and mapping while values match) | |
| * | |
| * ```ts | |
| * import { Chunk, Result } from "effect" | |
| * | |
| * const chunk = Chunk.make("1", "2", "hello", "3", "4") | |
| * const result = Chunk.filterMapWhile(chunk, (s) => { | |
| * const num = parseInt(s) | |
| * return isNaN(num) ? Result.failVoid : Result.succeed(num) | |
| * }) | |
| * console.log(Chunk.toArray(result)) // [1, 2] | |
| * // Stops at "hello" and doesn't process "3", "4" | |
| * | |
| * // Compare with regular filterMap | |
| * const allNumbers = Chunk.filterMap(chunk, (s) => { | |
| * const num = parseInt(s) | |
| * return isNaN(num) ? Result.failVoid : Result.succeed(num) | |
| * }) | |
| * console.log(Chunk.toArray(allNumbers)) // [1, 2, 3, 4] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const filterMapWhile = /*#__PURE__*/dual(2, (self, f) => { | |
| const out = []; | |
| for (const a of self) { | |
| const result = f(a); | |
| if (R.isSuccess(result)) { | |
| out.push(result.success); | |
| } else { | |
| break; | |
| } | |
| } | |
| return fromArrayUnsafe(out); | |
| }); | |
| /** | |
| * Filters out optional values | |
| * | |
| * **Example** (Compacting optional values) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make(Option.some(1), Option.none(), Option.some(3)) | |
| * const result = Chunk.compact(chunk) | |
| * console.log(Chunk.toArray(result)) // [1, 3] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const compact = self => { | |
| const out = []; | |
| for (const option of self) { | |
| if (O.isSome(option)) { | |
| out.push(option.value); | |
| } | |
| } | |
| return fromArrayUnsafe(out); | |
| }; | |
| /** | |
| * Applies a function to each element in a chunk and returns a new chunk containing the concatenated mapped elements. | |
| * | |
| * **Example** (Flat mapping chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * const duplicated = Chunk.flatMap(chunk, (n) => Chunk.make(n, n)) | |
| * console.log(Chunk.toArray(duplicated)) // [1, 1, 2, 2, 3, 3] | |
| * | |
| * // Flattening nested arrays | |
| * const words = Chunk.make("hello", "world") | |
| * const letters = Chunk.flatMap( | |
| * words, | |
| * (word) => Chunk.fromIterable(word.split("")) | |
| * ) | |
| * console.log(Chunk.toArray(letters)) // ["h", "e", "l", "l", "o", "w", "o", "r", "l", "d"] | |
| * | |
| * // With index parameter | |
| * const indexed = Chunk.flatMap(chunk, (n, i) => Chunk.make(n + i)) | |
| * console.log(Chunk.toArray(indexed)) // [1, 3, 5] | |
| * ``` | |
| * | |
| * @category sequencing | |
| * @since 2.0.0 | |
| */ | |
| export const flatMap = /*#__PURE__*/dual(2, (self, f) => { | |
| if (self.backing._tag === "ISingleton") { | |
| return f(self.backing.a, 0); | |
| } | |
| let out = _empty; | |
| let i = 0; | |
| for (const k of self) { | |
| out = appendAll(out, f(k, i++)); | |
| } | |
| return out; | |
| }); | |
| /** | |
| * Iterates over each element of a `Chunk` and applies a function to it. | |
| * | |
| * **Details** | |
| * | |
| * This function processes every element of the given `Chunk`, calling the | |
| * provided function `f` on each element. It does not return a new value; | |
| * instead, it is primarily used for side effects, such as logging or | |
| * accumulating data in an external variable. | |
| * | |
| * **Example** (Iterating over chunk values) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * | |
| * // Log each element | |
| * Chunk.forEach(chunk, (n) => console.log(`Value: ${n}`)) | |
| * // Output: | |
| * // Value: 1 | |
| * // Value: 2 | |
| * // Value: 3 | |
| * // Value: 4 | |
| * | |
| * // With index parameter | |
| * Chunk.forEach(chunk, (n, i) => console.log(`Index ${i}: ${n}`)) | |
| * // Output: | |
| * // Index 0: 1 | |
| * // Index 1: 2 | |
| * // Index 2: 3 | |
| * // Index 3: 4 | |
| * ``` | |
| * | |
| * @category combinators | |
| * @since 2.0.0 | |
| */ | |
| export const forEach = /*#__PURE__*/dual(2, (self, f) => toReadonlyArray(self).forEach(f)); | |
| /** | |
| * Flattens a chunk of chunks into a single chunk by concatenating all chunks. | |
| * | |
| * **Example** (Flattening nested chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const nested = Chunk.make( | |
| * Chunk.make(1, 2), | |
| * Chunk.make(3, 4, 5), | |
| * Chunk.make(6) | |
| * ) | |
| * const flattened = Chunk.flatten(nested) | |
| * console.log(Chunk.toArray(flattened)) // [1, 2, 3, 4, 5, 6] | |
| * | |
| * // With empty chunks | |
| * const withEmpty = Chunk.make( | |
| * Chunk.make(1, 2), | |
| * Chunk.empty<number>(), | |
| * Chunk.make(3, 4) | |
| * ) | |
| * console.log(Chunk.toArray(Chunk.flatten(withEmpty))) // [1, 2, 3, 4] | |
| * ``` | |
| * | |
| * @category sequencing | |
| * @since 2.0.0 | |
| */ | |
| export const flatten = /*#__PURE__*/flatMap(identity); | |
| /** | |
| * Groups elements in chunks of up to `n` elements. | |
| * | |
| * **When to use** | |
| * | |
| * Use to divide a chunk into ordered, non-overlapping chunks with at most `n` | |
| * elements each. | |
| * | |
| * **Details** | |
| * | |
| * The final chunk may contain fewer than `n` elements. Empty input produces an | |
| * empty chunk of chunks. | |
| * | |
| * **Gotchas** | |
| * | |
| * Values of `n` less than or equal to zero produce singleton chunks. | |
| * | |
| * **Example** (Splitting into fixed-size chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6, 7, 8, 9) | |
| * const chunked = Chunk.chunksOf(chunk, 3) | |
| * | |
| * console.log(Chunk.toArray(chunked).map(Chunk.toArray)) | |
| * // [[1, 2, 3], [4, 5, 6], [7, 8, 9]] | |
| * | |
| * // When length is not evenly divisible | |
| * const chunk2 = Chunk.make(1, 2, 3, 4, 5) | |
| * const chunked2 = Chunk.chunksOf(chunk2, 2) | |
| * console.log(Chunk.toArray(chunked2).map(Chunk.toArray)) | |
| * // [[1, 2], [3, 4], [5]] | |
| * ``` | |
| * | |
| * @see {@link split} for splitting into a target number of chunks instead of a fixed chunk size | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const chunksOf = /*#__PURE__*/dual(2, (self, n) => { | |
| const gr = []; | |
| let current = []; | |
| toReadonlyArray(self).forEach(a => { | |
| current.push(a); | |
| if (current.length >= n) { | |
| gr.push(fromArrayUnsafe(current)); | |
| current = []; | |
| } | |
| }); | |
| if (current.length > 0) { | |
| gr.push(fromArrayUnsafe(current)); | |
| } | |
| return fromArrayUnsafe(gr); | |
| }); | |
| /** | |
| * Creates a `Chunk` of values that are included in both chunks. | |
| * | |
| * **Details** | |
| * | |
| * The order and references of result values are determined by the first chunk. | |
| * | |
| * **Example** (Intersecting chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk1 = Chunk.make(1, 2, 3, 4) | |
| * const chunk2 = Chunk.make(3, 4, 5, 6) | |
| * const result = Chunk.intersection(chunk1, chunk2) | |
| * console.log(Chunk.toArray(result)) // [3, 4] | |
| * | |
| * // With strings | |
| * const words1 = Chunk.make("hello", "world", "foo") | |
| * const words2 = Chunk.make("world", "bar", "foo") | |
| * console.log(Chunk.toArray(Chunk.intersection(words1, words2))) // ["world", "foo"] | |
| * | |
| * // No intersection | |
| * const chunk3 = Chunk.make(1, 2) | |
| * const chunk4 = Chunk.make(3, 4) | |
| * console.log(Chunk.toArray(Chunk.intersection(chunk3, chunk4))) // [] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const intersection = /*#__PURE__*/dual(2, (self, that) => fromArrayUnsafe(RA.intersection(toReadonlyArray(self), toReadonlyArray(that)))); | |
| /** | |
| * Determines if the chunk is empty. | |
| * | |
| * **Example** (Checking for empty chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * console.log(Chunk.isEmpty(Chunk.empty())) // true | |
| * console.log(Chunk.isEmpty(Chunk.make(1, 2, 3))) // false | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const isEmpty = self => self.length === 0; | |
| /** | |
| * Determines if the chunk is not empty. | |
| * | |
| * **Example** (Checking for non-empty chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * console.log(Chunk.isNonEmpty(Chunk.empty())) // false | |
| * console.log(Chunk.isNonEmpty(Chunk.make(1, 2, 3))) // true | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const isNonEmpty = self => self.length > 0; | |
| /** | |
| * Returns the first element of this chunk safely if it exists. | |
| * | |
| * **Example** (Getting the first element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * console.log(Chunk.head(Chunk.empty())) // { _tag: "None" } | |
| * console.log(Chunk.head(Chunk.make(1, 2, 3))) // { _tag: "Some", value: 1 } | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const head = /*#__PURE__*/get(0); | |
| /** | |
| * Returns the first element of this chunk. | |
| * | |
| * **When to use** | |
| * | |
| * Use when you know the chunk is non-empty and need the first element directly | |
| * without handling `Option.none`. | |
| * | |
| * **Gotchas** | |
| * | |
| * Throws an error if the chunk is empty. | |
| * | |
| * **Example** (Getting the first element unsafely) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.headUnsafe(chunk)) // 1 | |
| * | |
| * const singleElement = Chunk.make("hello") | |
| * console.log(Chunk.headUnsafe(singleElement)) // "hello" | |
| * | |
| * // Use Chunk.head when the chunk may be empty | |
| * console.log(Option.isNone(Chunk.head(Chunk.empty()))) // true | |
| * ``` | |
| * | |
| * @category unsafe | |
| * @since 4.0.0 | |
| */ | |
| export const headUnsafe = self => getUnsafe(self, 0); | |
| /** | |
| * Returns the first element of this non empty chunk. | |
| * | |
| * **Example** (Getting the first element of a non-empty chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const nonEmptyChunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.headNonEmpty(nonEmptyChunk)) // 1 | |
| * | |
| * const singleElement = Chunk.make("hello") | |
| * console.log(Chunk.headNonEmpty(singleElement)) // "hello" | |
| * | |
| * // Type safety: this function only accepts NonEmptyChunk | |
| * // Chunk.headNonEmpty(Chunk.empty()) // TypeScript error | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const headNonEmpty = headUnsafe; | |
| /** | |
| * Returns the last element of this chunk safely if it exists. | |
| * | |
| * **Example** (Getting the last element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * console.log(Chunk.last(Chunk.empty())) // { _tag: "None" } | |
| * console.log(Chunk.last(Chunk.make(1, 2, 3))) // { _tag: "Some", value: 3 } | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const last = self => get(self, self.length - 1); | |
| /** | |
| * Returns the last element of this chunk. | |
| * | |
| * **When to use** | |
| * | |
| * Use when you know the chunk is non-empty and need the last element directly | |
| * without handling `Option.none`. | |
| * | |
| * **Gotchas** | |
| * | |
| * Throws an error if the chunk is empty. | |
| * | |
| * **Example** (Getting the last element unsafely) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.lastUnsafe(chunk)) // 4 | |
| * | |
| * const singleElement = Chunk.make("hello") | |
| * console.log(Chunk.lastUnsafe(singleElement)) // "hello" | |
| * | |
| * // Use Chunk.last when the chunk may be empty | |
| * console.log(Option.isNone(Chunk.last(Chunk.empty()))) // true | |
| * ``` | |
| * | |
| * @category unsafe | |
| * @since 4.0.0 | |
| */ | |
| export const lastUnsafe = self => getUnsafe(self, self.length - 1); | |
| /** | |
| * Returns the last element of this non empty chunk. | |
| * | |
| * **Example** (Getting the last element of a non-empty chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const nonEmptyChunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.lastNonEmpty(nonEmptyChunk)) // 4 | |
| * | |
| * const singleElement = Chunk.make("hello") | |
| * console.log(Chunk.lastNonEmpty(singleElement)) // "hello" | |
| * | |
| * // Type safety: this function only accepts NonEmptyChunk | |
| * // Chunk.lastNonEmpty(Chunk.empty()) // TypeScript error | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 3.4.0 | |
| */ | |
| export const lastNonEmpty = lastUnsafe; | |
| /** | |
| * Transforms the elements of a chunk using the specified mapping function. | |
| * If the input chunk is non-empty, the resulting chunk will also be non-empty. | |
| * | |
| * **Example** (Mapping values) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const result = Chunk.map(Chunk.make(1, 2), (n) => n + 1) | |
| * | |
| * console.log(Chunk.toArray(result)) // [2, 3] | |
| * ``` | |
| * | |
| * @category mapping | |
| * @since 2.0.0 | |
| */ | |
| export const map = /*#__PURE__*/dual(2, (self, f) => self.backing._tag === "ISingleton" ? of(f(self.backing.a, 0)) : fromArrayUnsafe(pipe(toReadonlyArray(self), RA.map((a, i) => f(a, i))))); | |
| /** | |
| * Maps over the chunk statefully, producing new elements of type `B`. | |
| * | |
| * **Example** (Mapping with accumulated state) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const [finalState, mapped] = Chunk.mapAccum(chunk, 0, (state, current) => [ | |
| * state + current, // accumulate sum | |
| * state + current // output running sum | |
| * ]) | |
| * | |
| * console.log(finalState) // 15 (final accumulated sum) | |
| * console.log(Chunk.toArray(mapped)) // [1, 3, 6, 10, 15] (running sums) | |
| * | |
| * // Building a string with indices | |
| * const words = Chunk.make("hello", "world", "effect") | |
| * const [count, indexed] = Chunk.mapAccum(words, 0, (index, word) => [ | |
| * index + 1, | |
| * `${index}: ${word}` | |
| * ]) | |
| * console.log(count) // 3 | |
| * console.log(Chunk.toArray(indexed)) // ["0: hello", "1: world", "2: effect"] | |
| * ``` | |
| * | |
| * @category folding | |
| * @since 2.0.0 | |
| */ | |
| export const mapAccum = /*#__PURE__*/dual(3, (self, s, f) => { | |
| const [s1, as] = RA.mapAccum(self, s, f); | |
| return [s1, fromArrayUnsafe(as)]; | |
| }); | |
| /** | |
| * Splits a chunk using a `Filter` into failures and successes. | |
| * | |
| * **Details** | |
| * | |
| * Returns `[excluded, satisfying]`. The filter receives `(element, index)`. | |
| * | |
| * **Example** (Partitioning with a Result) | |
| * | |
| * ```ts | |
| * import { Chunk, Result } from "effect" | |
| * | |
| * const [excluded, satisfying] = Chunk.partition(Chunk.make(1, -2, 3), (n, i) => | |
| * n > 0 ? Result.succeed(n + i) : Result.fail(`negative:${n}`) | |
| * ) | |
| * | |
| * console.log(Chunk.toArray(excluded)) // ["negative:-2"] | |
| * console.log(Chunk.toArray(satisfying)) // [1, 5] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const partition = /*#__PURE__*/dual(2, (self, f) => { | |
| const [excluded, satisfying] = RA.partition(self, f); | |
| return [fromArrayUnsafe(excluded), fromArrayUnsafe(satisfying)]; | |
| }); | |
| /** | |
| * Separates a chunk of `Result` values into a chunk of failures and a chunk of | |
| * successes. | |
| * | |
| * **Details** | |
| * | |
| * The returned tuple is `[failures, successes]`, preserving the original order | |
| * within each side. | |
| * | |
| * **Example** (Separating failures and successes) | |
| * | |
| * ```ts | |
| * import { Chunk, Result } from "effect" | |
| * | |
| * const chunk = Chunk.make( | |
| * Result.succeed(1), | |
| * Result.fail("error1"), | |
| * Result.succeed(2), | |
| * Result.fail("error2"), | |
| * Result.succeed(3) | |
| * ) | |
| * | |
| * const [errors, values] = Chunk.separate(chunk) | |
| * console.log(Chunk.toArray(errors)) // ["error1", "error2"] | |
| * console.log(Chunk.toArray(values)) // [1, 2, 3] | |
| * | |
| * // All successes | |
| * const allSuccesses = Chunk.make(Result.succeed(1), Result.succeed(2)) | |
| * const [noErrors, allValues] = Chunk.separate(allSuccesses) | |
| * console.log(Chunk.toArray(noErrors)) // [] | |
| * console.log(Chunk.toArray(allValues)) // [1, 2] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const separate = self => pipe(RA.separate(toReadonlyArray(self)), ([l, r]) => [fromArrayUnsafe(l), fromArrayUnsafe(r)]); | |
| /** | |
| * Retrieves the size of the chunk. | |
| * | |
| * **Example** (Getting chunk size) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3) | |
| * console.log(Chunk.size(chunk)) // 3 | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const size = self => self.length; | |
| /** | |
| * Sorts the elements of a `Chunk` in increasing order, creating a new `Chunk`. | |
| * | |
| * **Example** (Sorting chunks) | |
| * | |
| * ```ts | |
| * import { Chunk, Order } from "effect" | |
| * | |
| * const numbers = Chunk.make(3, 1, 4, 1, 5, 9, 2, 6) | |
| * const sorted = Chunk.sort(numbers, Order.Number) | |
| * console.log(Chunk.toArray(sorted)) // [1, 1, 2, 3, 4, 5, 6, 9] | |
| * | |
| * // Reverse order | |
| * const reverseSorted = Chunk.sort(numbers, Order.flip(Order.Number)) | |
| * console.log(Chunk.toArray(reverseSorted)) // [9, 6, 5, 4, 3, 2, 1, 1] | |
| * | |
| * // String sorting | |
| * const words = Chunk.make("banana", "apple", "cherry") | |
| * const sortedWords = Chunk.sort(words, Order.String) | |
| * console.log(Chunk.toArray(sortedWords)) // ["apple", "banana", "cherry"] | |
| * ``` | |
| * | |
| * @category sorting | |
| * @since 2.0.0 | |
| */ | |
| export const sort = /*#__PURE__*/dual(2, (self, O) => fromArrayUnsafe(RA.sort(toReadonlyArray(self), O))); | |
| /** | |
| * Sorts the elements of a `Chunk` based on a projection function. | |
| * | |
| * **Example** (Sorting chunks by a derived value) | |
| * | |
| * ```ts | |
| * import { Chunk, Order } from "effect" | |
| * | |
| * const people = Chunk.make( | |
| * { name: "Alice", age: 30 }, | |
| * { name: "Bob", age: 25 }, | |
| * { name: "Charlie", age: 35 } | |
| * ) | |
| * | |
| * // Sort by age | |
| * const byAge = Chunk.sortWith(people, (person) => person.age, Order.Number) | |
| * console.log(Chunk.toArray(byAge)) | |
| * // [{ name: "Bob", age: 25 }, { name: "Alice", age: 30 }, { name: "Charlie", age: 35 }] | |
| * | |
| * // Sort by name | |
| * const byName = Chunk.sortWith(people, (person) => person.name, Order.String) | |
| * console.log(Chunk.toArray(byName)) | |
| * // [{ name: "Alice", age: 30 }, { name: "Bob", age: 25 }, { name: "Charlie", age: 35 }] | |
| * | |
| * // Sort by string length | |
| * const words = Chunk.make("a", "abc", "ab") | |
| * const byLength = Chunk.sortWith(words, (word) => word.length, Order.Number) | |
| * console.log(Chunk.toArray(byLength)) // ["a", "ab", "abc"] | |
| * ``` | |
| * | |
| * @category sorting | |
| * @since 2.0.0 | |
| */ | |
| export const sortWith = /*#__PURE__*/dual(3, (self, f, order) => sort(self, Order.mapInput(order, f))); | |
| /** | |
| * Returns two splits of this chunk at the specified index. | |
| * | |
| * **Example** (Splitting at an index) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6) | |
| * const [before, after] = Chunk.splitAt(chunk, 3) | |
| * console.log(Chunk.toArray(before)) // [1, 2, 3] | |
| * console.log(Chunk.toArray(after)) // [4, 5, 6] | |
| * | |
| * // Split at index 0 | |
| * const [empty, all] = Chunk.splitAt(chunk, 0) | |
| * console.log(Chunk.toArray(empty)) // [] | |
| * console.log(Chunk.toArray(all)) // [1, 2, 3, 4, 5, 6] | |
| * | |
| * // Split beyond length | |
| * const [allElements, empty2] = Chunk.splitAt(chunk, 10) | |
| * console.log(Chunk.toArray(allElements)) // [1, 2, 3, 4, 5, 6] | |
| * console.log(Chunk.toArray(empty2)) // [] | |
| * ``` | |
| * | |
| * @category splitting | |
| * @since 2.0.0 | |
| */ | |
| export const splitAt = /*#__PURE__*/dual(2, (self, n) => [take(self, n), drop(self, n)]); | |
| /** | |
| * Splits a `NonEmptyChunk` at `n`, returning a non-empty prefix and the | |
| * remaining suffix. | |
| * | |
| * **Details** | |
| * | |
| * `n` is floored and normalized to at least `1`. If `n` is greater than or | |
| * equal to the chunk length, the first result is the original chunk and the | |
| * second result is empty. | |
| * | |
| * **Example** (Splitting non-empty chunks at an index) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const nonEmptyChunk = Chunk.make(1, 2, 3, 4, 5, 6) | |
| * const [before, after] = Chunk.splitNonEmptyAt(nonEmptyChunk, 3) | |
| * console.log(Chunk.toArray(before)) // [1, 2, 3] | |
| * console.log(Chunk.toArray(after)) // [4, 5, 6] | |
| * | |
| * // Split at 1 (minimum) | |
| * const [first, rest] = Chunk.splitNonEmptyAt(nonEmptyChunk, 1) | |
| * console.log(Chunk.toArray(first)) // [1] | |
| * console.log(Chunk.toArray(rest)) // [2, 3, 4, 5, 6] | |
| * | |
| * // The first part is guaranteed to be NonEmptyChunk | |
| * // while the second part may be empty | |
| * ``` | |
| * | |
| * @category splitting | |
| * @since 2.0.0 | |
| */ | |
| export const splitNonEmptyAt = /*#__PURE__*/dual(2, (self, n) => { | |
| const _n = Math.max(1, Math.floor(n)); | |
| return _n >= self.length ? [self, empty()] : [take(self, _n), drop(self, _n)]; | |
| }); | |
| /** | |
| * Splits a chunk into up to `n` chunks, distributing elements in order. | |
| * | |
| * **Details** | |
| * | |
| * The chunk size is derived from the input length and `n`; the final chunk may | |
| * contain fewer elements than the others. | |
| * | |
| * **Example** (Splitting chunks into groups) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6, 7, 8, 9) | |
| * const chunks = Chunk.split(chunk, 3) | |
| * console.log(Chunk.toArray(chunks).map(Chunk.toArray)) | |
| * // [[1, 2, 3], [4, 5, 6], [7, 8, 9]] | |
| * | |
| * // Uneven split | |
| * const chunk2 = Chunk.make(1, 2, 3, 4, 5, 6, 7, 8) | |
| * const chunks2 = Chunk.split(chunk2, 3) | |
| * console.log(Chunk.toArray(chunks2).map(Chunk.toArray)) | |
| * // [[1, 2, 3], [4, 5, 6], [7, 8]] | |
| * | |
| * // Split into 1 chunk | |
| * const chunks3 = Chunk.split(chunk, 1) | |
| * console.log(Chunk.toArray(chunks3).map(Chunk.toArray)) | |
| * // [[1, 2, 3, 4, 5, 6, 7, 8, 9]] | |
| * ``` | |
| * | |
| * @category splitting | |
| * @since 2.0.0 | |
| */ | |
| export const split = /*#__PURE__*/dual(2, (self, n) => chunksOf(self, Math.ceil(self.length / Math.floor(n)))); | |
| /** | |
| * Splits this chunk on the first element that matches this predicate. | |
| * Returns a tuple containing two chunks: the first one is before the match, and the second one is from the match onward. | |
| * | |
| * **Example** (Splitting at a matching element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6) | |
| * const [before, fromMatch] = Chunk.splitWhere(chunk, (n) => n > 3) | |
| * console.log(Chunk.toArray(before)) // [1, 2, 3] | |
| * console.log(Chunk.toArray(fromMatch)) // [4, 5, 6] | |
| * | |
| * // No match found | |
| * const [all, empty] = Chunk.splitWhere(chunk, (n) => n > 10) | |
| * console.log(Chunk.toArray(all)) // [1, 2, 3, 4, 5, 6] | |
| * console.log(Chunk.toArray(empty)) // [] | |
| * | |
| * // Match on first element | |
| * const [emptyBefore, allFromFirst] = Chunk.splitWhere(chunk, (n) => n === 1) | |
| * console.log(Chunk.toArray(emptyBefore)) // [] | |
| * console.log(Chunk.toArray(allFromFirst)) // [1, 2, 3, 4, 5, 6] | |
| * ``` | |
| * | |
| * @category splitting | |
| * @since 2.0.0 | |
| */ | |
| export const splitWhere = /*#__PURE__*/dual(2, (self, predicate) => { | |
| let i = 0; | |
| for (const a of toReadonlyArray(self)) { | |
| if (predicate(a)) { | |
| break; | |
| } else { | |
| i++; | |
| } | |
| } | |
| return splitAt(self, i); | |
| }); | |
| /** | |
| * Returns every element after the first safely, or `None` when the chunk is empty. | |
| * | |
| * **Example** (Getting the tail safely) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * console.log(Chunk.tail(chunk)) // Option.some(Chunk.make(2, 3, 4)) | |
| * | |
| * const singleElement = Chunk.make(1) | |
| * console.log(Chunk.tail(singleElement)) // Option.some(Chunk.empty()) | |
| * | |
| * const empty = Chunk.empty<number>() | |
| * console.log(Chunk.tail(empty)) // Option.none() | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const tail = self => self.length > 0 ? O.some(drop(self, 1)) : O.none(); | |
| /** | |
| * Returns every element after the first from a non-empty chunk. | |
| * | |
| * **Example** (Getting the tail of a non-empty chunk) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const nonEmptyChunk = Chunk.make(1, 2, 3, 4) | |
| * const result = Chunk.tailNonEmpty(nonEmptyChunk) | |
| * console.log(Chunk.toArray(result)) // [2, 3, 4] | |
| * | |
| * const singleElement = Chunk.make(1) | |
| * const resultSingle = Chunk.tailNonEmpty(singleElement) | |
| * console.log(Chunk.toArray(resultSingle)) // [] | |
| * | |
| * // Type safety: this function only accepts NonEmptyChunk | |
| * // Chunk.tailNonEmpty(Chunk.empty()) // TypeScript error | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const tailNonEmpty = self => drop(self, 1); | |
| /** | |
| * Takes the last `n` elements. | |
| * | |
| * **Example** (Taking elements from the end) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5, 6) | |
| * const lastThree = Chunk.takeRight(chunk, 3) | |
| * console.log(Chunk.toArray(lastThree)) // [4, 5, 6] | |
| * | |
| * // Take more than available | |
| * const all = Chunk.takeRight(chunk, 10) | |
| * console.log(Chunk.toArray(all)) // [1, 2, 3, 4, 5, 6] | |
| * | |
| * // Take zero | |
| * const none = Chunk.takeRight(chunk, 0) | |
| * console.log(Chunk.toArray(none)) // [] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const takeRight = /*#__PURE__*/dual(2, (self, n) => drop(self, self.length - n)); | |
| /** | |
| * Takes all elements so long as the predicate returns true. | |
| * | |
| * **Example** (Taking elements while a predicate matches) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 3, 2, 1) | |
| * const result = Chunk.takeWhile(chunk, (n) => n < 4) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3] | |
| * | |
| * // Empty if first element doesn't match | |
| * const none = Chunk.takeWhile(chunk, (n) => n > 5) | |
| * console.log(Chunk.toArray(none)) // [] | |
| * | |
| * // Takes all if all match | |
| * const small = Chunk.make(1, 2, 3) | |
| * const all = Chunk.takeWhile(small, (n) => n < 10) | |
| * console.log(Chunk.toArray(all)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const takeWhile = /*#__PURE__*/dual(2, (self, predicate) => { | |
| const out = []; | |
| for (const a of toReadonlyArray(self)) { | |
| if (predicate(a)) { | |
| out.push(a); | |
| } else { | |
| break; | |
| } | |
| } | |
| return fromArrayUnsafe(out); | |
| }); | |
| /** | |
| * Creates a Chunks of unique values, in order, from all given Chunks. | |
| * | |
| * **Example** (Unioning chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk1 = Chunk.make(1, 2, 3) | |
| * const chunk2 = Chunk.make(3, 4, 5) | |
| * const result = Chunk.union(chunk1, chunk2) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3, 4, 5] | |
| * | |
| * // Handles duplicates within the same chunk | |
| * const withDupes1 = Chunk.make(1, 1, 2) | |
| * const withDupes2 = Chunk.make(2, 3, 3) | |
| * const unified = Chunk.union(withDupes1, withDupes2) | |
| * console.log(Chunk.toArray(unified)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const union = /*#__PURE__*/dual(2, (self, that) => fromArrayUnsafe(RA.union(toReadonlyArray(self), toReadonlyArray(that)))); | |
| /** | |
| * Removes duplicate elements from a `Chunk`, preserving the first occurrence | |
| * of each value. | |
| * | |
| * **Example** (Removing duplicate values) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 2, 3, 1, 4, 3) | |
| * const result = Chunk.dedupe(chunk) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3, 4] | |
| * | |
| * // Empty chunk | |
| * const empty = Chunk.empty<number>() | |
| * const emptyDeduped = Chunk.dedupe(empty) | |
| * console.log(Chunk.toArray(emptyDeduped)) // [] | |
| * | |
| * // No duplicates | |
| * const unique = Chunk.make(1, 2, 3) | |
| * const uniqueDeduped = Chunk.dedupe(unique) | |
| * console.log(Chunk.toArray(uniqueDeduped)) // [1, 2, 3] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const dedupe = self => fromArrayUnsafe(RA.dedupe(toReadonlyArray(self))); | |
| /** | |
| * Deduplicates adjacent elements that are identical. | |
| * | |
| * **Example** (Removing adjacent duplicates) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 1, 2, 2, 2, 3, 1, 1) | |
| * const result = Chunk.dedupeAdjacent(chunk) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 3, 1] | |
| * | |
| * // Only removes adjacent duplicates, not all duplicates | |
| * const mixed = Chunk.make("a", "a", "b", "a", "a") | |
| * const mixedResult = Chunk.dedupeAdjacent(mixed) | |
| * console.log(Chunk.toArray(mixedResult)) // ["a", "b", "a"] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 2.0.0 | |
| */ | |
| export const dedupeAdjacent = self => fromArrayUnsafe(RA.dedupeAdjacent(self)); | |
| /** | |
| * Takes a `Chunk` of pairs and returns two corresponding `Chunk`s. | |
| * | |
| * **Details** | |
| * | |
| * This function is the reverse of `zip`. | |
| * | |
| * **Example** (Unzipping pairs) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const pairs = Chunk.make( | |
| * [1, "a"] as const, | |
| * [2, "b"] as const, | |
| * [3, "c"] as const | |
| * ) | |
| * const [numbers, letters] = Chunk.unzip(pairs) | |
| * console.log(Chunk.toArray(numbers)) // [1, 2, 3] | |
| * console.log(Chunk.toArray(letters)) // ["a", "b", "c"] | |
| * | |
| * // Empty chunk | |
| * const empty = Chunk.empty<[number, string]>() | |
| * const [emptyNums, emptyStrs] = Chunk.unzip(empty) | |
| * console.log(Chunk.toArray(emptyNums)) // [] | |
| * console.log(Chunk.toArray(emptyStrs)) // [] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const unzip = self => { | |
| const [left, right] = RA.unzip(self); | |
| return [fromArrayUnsafe(left), fromArrayUnsafe(right)]; | |
| }; | |
| /** | |
| * Zips this chunk pointwise with the specified chunk using the specified combiner. | |
| * | |
| * **Example** (Zipping chunks with a function) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const numbers = Chunk.make(1, 2, 3) | |
| * const letters = Chunk.make("a", "b", "c") | |
| * const result = Chunk.zipWith(numbers, letters, (n, l) => `${n}-${l}`) | |
| * console.log(Chunk.toArray(result)) // ["1-a", "2-b", "3-c"] | |
| * | |
| * // Different lengths - takes minimum | |
| * const short = Chunk.make(1, 2) | |
| * const long = Chunk.make("a", "b", "c", "d") | |
| * const mixed = Chunk.zipWith(short, long, (n, l) => [n, l]) | |
| * console.log(Chunk.toArray(mixed)) // [[1, "a"], [2, "b"]] | |
| * ``` | |
| * | |
| * @category zipping | |
| * @since 2.0.0 | |
| */ | |
| export const zipWith = /*#__PURE__*/dual(3, (self, that, f) => fromArrayUnsafe(RA.zipWith(self, that, f))); | |
| /** | |
| * Zips this chunk pointwise with the specified chunk. | |
| * | |
| * **Example** (Zipping chunks) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const numbers = Chunk.make(1, 2, 3) | |
| * const letters = Chunk.make("a", "b", "c") | |
| * const result = Chunk.zip(numbers, letters) | |
| * console.log(Chunk.toArray(result)) // [[1, "a"], [2, "b"], [3, "c"]] | |
| * | |
| * // Different lengths - takes minimum length | |
| * const short = Chunk.make(1, 2) | |
| * const long = Chunk.make("a", "b", "c", "d") | |
| * const zipped = Chunk.zip(short, long) | |
| * console.log(Chunk.toArray(zipped)) // [[1, "a"], [2, "b"]] | |
| * ``` | |
| * | |
| * @category zipping | |
| * @since 2.0.0 | |
| */ | |
| export const zip = /*#__PURE__*/dual(2, (self, that) => zipWith(self, that, (a, b) => [a, b])); | |
| /** | |
| * Deletes the element at the specified index, creating a new `Chunk`. | |
| * | |
| * **Example** (Removing an element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make("a", "b", "c", "d") | |
| * const result = Chunk.remove(chunk, 1) | |
| * console.log(Chunk.toArray(result)) // ["a", "c", "d"] | |
| * | |
| * // Remove first element | |
| * const removeFirst = Chunk.remove(chunk, 0) | |
| * console.log(Chunk.toArray(removeFirst)) // ["b", "c", "d"] | |
| * | |
| * // Index out of bounds returns same chunk | |
| * const outOfBounds = Chunk.remove(chunk, 10) | |
| * console.log(Chunk.toArray(outOfBounds)) // ["a", "b", "c", "d"] | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const remove = /*#__PURE__*/dual(2, (self, i) => fromArrayUnsafe(RA.remove(toReadonlyArray(self), i))); | |
| /** | |
| * Applies a function to the element at the specified index safely, creating a new `Chunk`, | |
| * or returns `None` if the index is out of bounds. | |
| * | |
| * **Example** (Modifying an element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * const result = Chunk.modify(chunk, 1, (n) => n * 10) | |
| * console.log(result) // Option.some(Chunk.make(1, 20, 3, 4)) | |
| * | |
| * // Index out of bounds returns None | |
| * const outOfBounds = chunk.pipe(Chunk.modify(10, (n) => n * 10)) | |
| * console.log(outOfBounds) // Option.none() | |
| * | |
| * // Negative index returns None | |
| * const negative = chunk.pipe(Chunk.modify(-1, (n) => n * 10)) | |
| * console.log(negative) // Option.none() | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const modify = /*#__PURE__*/dual(3, (self, i, f) => pipe(RA.modify(toReadonlyArray(self), i, f), O.map(fromArrayUnsafe))); | |
| /** | |
| * Changes the element at the specified index safely, creating a new `Chunk`, | |
| * or returns `None` if the index is out of bounds. | |
| * | |
| * **Example** (Replacing an element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make("a", "b", "c", "d") | |
| * const result = Chunk.replace(chunk, 1, "X") | |
| * console.log(result) // Option.some(Chunk.make("a", "X", "c", "d")) | |
| * | |
| * // Index out of bounds returns None | |
| * const outOfBounds = chunk.pipe(Chunk.replace(10, "Y")) | |
| * console.log(outOfBounds) // Option.none() | |
| * | |
| * // Negative index returns None | |
| * const negative = chunk.pipe(Chunk.replace(-1, "Z")) | |
| * console.log(negative) // Option.none() | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const replace = /*#__PURE__*/dual(3, (self, i, b) => modify(self, i, () => b)); | |
| /** | |
| * Returns a non-empty `Chunk` of length `n` with element `i` initialized by `f(i)`. | |
| * | |
| * **Details** | |
| * | |
| * `n` is normalized to an integer greater than or equal to `1`. | |
| * | |
| * **Example** (Generating chunks from indices) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.makeBy(5, (i) => i * 2) | |
| * console.log(Chunk.toArray(chunk)) // [0, 2, 4, 6, 8] | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const makeBy = /*#__PURE__*/dual(2, (n, f) => fromIterable(RA.makeBy(n, f))); | |
| /** | |
| * Creates a non-empty `Chunk` of consecutive integers from `start` through | |
| * `end`, inclusive. | |
| * | |
| * **Details** | |
| * | |
| * If `start` is greater than `end`, returns a single-element chunk containing | |
| * `start`. | |
| * | |
| * **Example** (Creating a range) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.range(1, 5) | |
| * console.log(Chunk.toArray(chunk)) // [1, 2, 3, 4, 5] | |
| * ``` | |
| * | |
| * @category constructors | |
| * @since 2.0.0 | |
| */ | |
| export const range = (start, end) => start <= end ? makeBy(end - start + 1, i => start + i) : of(start); | |
| // ------------------------------------------------------------------------------------- | |
| // re-exports from ReadonlyArray | |
| // ------------------------------------------------------------------------------------- | |
| /** | |
| * Returns a function that checks if a `Chunk` contains a given value using the default `Equivalence`. | |
| * | |
| * **Example** (Checking membership) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * console.log(Chunk.contains(chunk, 3)) // true | |
| * console.log(Chunk.contains(chunk, 6)) // false | |
| * | |
| * // Works with strings | |
| * const words = Chunk.make("apple", "banana", "cherry") | |
| * console.log(Chunk.contains(words, "banana")) // true | |
| * console.log(Chunk.contains(words, "grape")) // false | |
| * | |
| * // Empty chunk | |
| * const empty = Chunk.empty<number>() | |
| * console.log(Chunk.contains(empty, 1)) // false | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const contains = RA.contains; | |
| /** | |
| * Returns a function that checks if a `Chunk` contains a given value using a provided `isEquivalent` function. | |
| * | |
| * **Example** (Checking membership with custom equivalence) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make({ id: 1, name: "Alice" }, { id: 2, name: "Bob" }) | |
| * | |
| * // Custom equivalence by id | |
| * const containsById = Chunk.containsWith<{ id: number; name: string }>((a, b) => | |
| * a.id === b.id | |
| * ) | |
| * console.log(containsById(chunk, { id: 1, name: "Different" })) // true | |
| * console.log(containsById(chunk, { id: 3, name: "Charlie" })) // false | |
| * | |
| * // Case-insensitive string comparison | |
| * const words = Chunk.make("Apple", "Banana", "Cherry") | |
| * const containsCaseInsensitive = Chunk.containsWith<string>((a, b) => | |
| * a.toLowerCase() === b.toLowerCase() | |
| * ) | |
| * console.log(containsCaseInsensitive(words, "apple")) // true | |
| * console.log(containsCaseInsensitive(words, "grape")) // false | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const containsWith = RA.containsWith; | |
| /** | |
| * Returns the first element that satisfies the specified | |
| * predicate, or `None` if no such element exists. | |
| * | |
| * **Example** (Finding the first matching element) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.findFirst(chunk, (n) => n > 3) | |
| * console.log(Option.isSome(result)) // true | |
| * console.log(Option.getOrElse(result, () => 0)) // 4 | |
| * | |
| * // No match found | |
| * const notFound = Chunk.findFirst(chunk, (n) => n > 10) | |
| * console.log(Option.isNone(notFound)) // true | |
| * | |
| * // With type refinement | |
| * const mixed = Chunk.make(1, "hello", 2, "world", 3) | |
| * const firstString = Chunk.findFirst( | |
| * mixed, | |
| * (x): x is string => typeof x === "string" | |
| * ) | |
| * console.log(Option.getOrElse(firstString, () => "")) // "hello" | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const findFirst = RA.findFirst; | |
| /** | |
| * Returns the first index for which a predicate holds. | |
| * | |
| * **Example** (Finding the first matching index) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.findFirstIndex(chunk, (n) => n > 3) | |
| * console.log(result) // Option.some(3) | |
| * | |
| * // No match found | |
| * const notFound = Chunk.findFirstIndex(chunk, (n) => n > 10) | |
| * console.log(notFound) // Option.none() | |
| * | |
| * // Find first even number | |
| * const firstEven = Chunk.findFirstIndex(chunk, (n) => n % 2 === 0) | |
| * console.log(firstEven) // Option.some(1) | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const findFirstIndex = /*#__PURE__*/dual(2, (self, predicate) => RA.findFirstIndex(self, predicate)); | |
| /** | |
| * Finds the last element for which a predicate holds. | |
| * | |
| * **Example** (Finding the last matching element) | |
| * | |
| * ```ts | |
| * import { Chunk, Option } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.findLast(chunk, (n) => n < 4) | |
| * console.log(Option.isSome(result)) // true | |
| * console.log(Option.getOrElse(result, () => 0)) // 3 | |
| * | |
| * // No match found | |
| * const notFound = Chunk.findLast(chunk, (n) => n > 10) | |
| * console.log(Option.isNone(notFound)) // true | |
| * | |
| * // Find last even number | |
| * const lastEven = Chunk.findLast(chunk, (n) => n % 2 === 0) | |
| * console.log(Option.getOrElse(lastEven, () => 0)) // 4 | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const findLast = RA.findLast; | |
| /** | |
| * Returns the last index for which a predicate holds. | |
| * | |
| * **Example** (Finding the last matching index) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const result = Chunk.findLastIndex(chunk, (n) => n < 4) | |
| * console.log(result) // Option.some(2) | |
| * | |
| * // No match found | |
| * const notFound = Chunk.findLastIndex(chunk, (n) => n > 10) | |
| * console.log(notFound) // Option.none() | |
| * | |
| * // Find last even number index | |
| * const lastEven = Chunk.findLastIndex(chunk, (n) => n % 2 === 0) | |
| * console.log(lastEven) // Option.some(3) | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const findLastIndex = /*#__PURE__*/dual(2, (self, predicate) => RA.findLastIndex(self, predicate)); | |
| /** | |
| * Checks whether a predicate holds true for every `Chunk` element. | |
| * | |
| * **Example** (Checking every element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const allPositive = Chunk.make(1, 2, 3, 4, 5) | |
| * console.log(Chunk.every(allPositive, (n) => n > 0)) // true | |
| * console.log(Chunk.every(allPositive, (n) => n > 3)) // false | |
| * | |
| * // Empty chunk returns true | |
| * const empty = Chunk.empty<number>() | |
| * console.log(Chunk.every(empty, (n) => n > 0)) // true | |
| * | |
| * // Type refinement | |
| * const mixed = Chunk.make(1, 2, 3) | |
| * if (Chunk.every(mixed, (x): x is number => typeof x === "number")) { | |
| * // mixed is now typed as Chunk<number> | |
| * console.log("All elements are numbers") | |
| * } | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const every = /*#__PURE__*/dual(2, (self, refinement) => RA.fromIterable(self).every(refinement)); | |
| /** | |
| * Checks whether a predicate holds true for some `Chunk` element. | |
| * | |
| * **Example** (Checking for some matching element) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * console.log(Chunk.some(chunk, (n) => n > 4)) // true | |
| * console.log(Chunk.some(chunk, (n) => n > 10)) // false | |
| * | |
| * // Empty chunk returns false | |
| * const empty = Chunk.empty<number>() | |
| * console.log(Chunk.some(empty, (n) => n > 0)) // false | |
| * | |
| * // Check for specific value | |
| * const words = Chunk.make("apple", "banana", "cherry") | |
| * console.log(Chunk.some(words, (word) => word.includes("ban"))) // true | |
| * ``` | |
| * | |
| * @category elements | |
| * @since 2.0.0 | |
| */ | |
| export const some = /*#__PURE__*/dual(2, (self, predicate) => RA.fromIterable(self).some(predicate)); | |
| /** | |
| * Joins the elements together with "sep" in the middle. | |
| * | |
| * **Example** (Joining chunks into a string) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make("apple", "banana", "cherry") | |
| * const result = Chunk.join(chunk, ", ") | |
| * console.log(result) // "apple, banana, cherry" | |
| * | |
| * // With different separator | |
| * const withPipe = Chunk.join(chunk, " | ") | |
| * console.log(withPipe) // "apple | banana | cherry" | |
| * | |
| * // Empty chunk | |
| * const empty = Chunk.empty<string>() | |
| * console.log(Chunk.join(empty, ", ")) // "" | |
| * | |
| * // Single element | |
| * const single = Chunk.make("hello") | |
| * console.log(Chunk.join(single, ", ")) // "hello" | |
| * ``` | |
| * | |
| * @category folding | |
| * @since 2.0.0 | |
| */ | |
| export const join = RA.join; | |
| /** | |
| * Reduces the elements of a chunk from left to right. | |
| * | |
| * **Example** (Reducing from the left) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4, 5) | |
| * const sum = Chunk.reduce(chunk, 0, (acc, n) => acc + n) | |
| * console.log(sum) // 15 | |
| * | |
| * // String concatenation with index | |
| * const words = Chunk.make("a", "b", "c") | |
| * const result = Chunk.reduce(words, "", (acc, word, i) => acc + `${i}:${word} `) | |
| * console.log(result) // "0:a 1:b 2:c " | |
| * | |
| * // Find maximum | |
| * const max = Chunk.reduce(chunk, -Infinity, (acc, n) => Math.max(acc, n)) | |
| * console.log(max) // 5 | |
| * ``` | |
| * | |
| * @category folding | |
| * @since 2.0.0 | |
| */ | |
| export const reduce = RA.reduce; | |
| /** | |
| * Reduces the elements of a chunk from right to left. | |
| * | |
| * **Example** (Reducing from the right) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk = Chunk.make(1, 2, 3, 4) | |
| * const result = Chunk.reduceRight(chunk, 0, (acc, n) => acc + n) | |
| * console.log(result) // 10 | |
| * | |
| * // String building (right to left) | |
| * const words = Chunk.make("a", "b", "c") | |
| * const reversed = Chunk.reduceRight( | |
| * words, | |
| * "", | |
| * (acc, word, i) => acc + `${i}:${word} ` | |
| * ) | |
| * console.log(reversed) // "2:c 1:b 0:a " | |
| * | |
| * // Subtract from right to left | |
| * const subtraction = Chunk.reduceRight(chunk, 0, (acc, n) => n - acc) | |
| * console.log(subtraction) // -2 (4 - (3 - (2 - (1 - 0)))) | |
| * ``` | |
| * | |
| * @category folding | |
| * @since 2.0.0 | |
| */ | |
| export const reduceRight = RA.reduceRight; | |
| /** | |
| * Creates a `Chunk` of values not included in the other given `Chunk` using the provided `isEquivalent` function. | |
| * The order and references of result values are determined by the first `Chunk`. | |
| * | |
| * **Example** (Computing difference with custom equivalence) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk1 = Chunk.make({ id: 1, name: "Alice" }, { id: 2, name: "Bob" }) | |
| * const chunk2 = Chunk.make({ id: 1, name: "Alice" }, { id: 3, name: "Charlie" }) | |
| * | |
| * // Custom equivalence by id | |
| * const byId = Chunk.differenceWith<{ id: number; name: string }>((a, b) => | |
| * a.id === b.id | |
| * ) | |
| * const result = byId(chunk1, chunk2) | |
| * console.log(Chunk.toArray(result)) // [{ id: 2, name: "Bob" }] | |
| * | |
| * // String comparison case-insensitive | |
| * const words1 = Chunk.make("Apple", "Banana", "Cherry") | |
| * const words2 = Chunk.make("apple", "grape") | |
| * const caseInsensitive = Chunk.differenceWith<string>((a, b) => | |
| * a.toLowerCase() === b.toLowerCase() | |
| * ) | |
| * const wordDiff = caseInsensitive(words1, words2) | |
| * console.log(Chunk.toArray(wordDiff)) // ["Banana", "Cherry"] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 3.2.0 | |
| */ | |
| export const differenceWith = isEquivalent => { | |
| return dual(2, (self, that) => fromArrayUnsafe(RA.differenceWith(isEquivalent)(self, that))); | |
| }; | |
| /** | |
| * Creates a `Chunk` of values not included in the other given `Chunk`. | |
| * The order and references of result values are determined by the first `Chunk`. | |
| * | |
| * **Example** (Computing chunk difference) | |
| * | |
| * ```ts | |
| * import { Chunk } from "effect" | |
| * | |
| * const chunk1 = Chunk.make(1, 2, 3, 4, 5) | |
| * const chunk2 = Chunk.make(3, 4, 6, 7) | |
| * const result = Chunk.difference(chunk1, chunk2) | |
| * console.log(Chunk.toArray(result)) // [1, 2, 5] | |
| * | |
| * // String difference | |
| * const words1 = Chunk.make("apple", "banana", "cherry") | |
| * const words2 = Chunk.make("banana", "grape") | |
| * const wordDiff = Chunk.difference(words1, words2) | |
| * console.log(Chunk.toArray(wordDiff)) // ["apple", "cherry"] | |
| * | |
| * // Empty second chunk returns original | |
| * const empty = Chunk.empty<number>() | |
| * const unchanged = Chunk.difference(chunk1, empty) | |
| * console.log(Chunk.toArray(unchanged)) // [1, 2, 3, 4, 5] | |
| * ``` | |
| * | |
| * @category filtering | |
| * @since 3.2.0 | |
| */ | |
| export const difference = /*#__PURE__*/dual(2, (self, that) => fromArrayUnsafe(RA.difference(self, that))); | |
| //# sourceMappingURL=Chunk.js.map |
Xet Storage Details
- Size:
- 67.6 kB
- Xet hash:
- 208b63abd981506928008e5241ba00150b391c7eff324bc65840aa33c47c5eac
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.