effect 4.0.0-beta.70 → 4.0.0-beta.72

package/src/Chunk.ts

@@ -319,7 +319,7 @@ const makeChunk = <A>(backing: Backing<A>): Chunk<A> => {
 }
 
 /**
- * Checks if `u` is a `Chunk<unknown>`
+ * Checks whether `u` is a `Chunk<unknown>`
  *
  * **Example** (Checking for chunks)
  *
@@ -339,7 +339,7 @@ const makeChunk = <A>(backing: Backing<A>): Chunk<A> => {
  */
 export const isChunk: {
   /**
-   * Checks if `u` is a `Chunk<unknown>`
+   * Checks whether `u` is a `Chunk<unknown>`
    *
    * **Example** (Checking for chunks)
    *
@@ -359,7 +359,7 @@ export const isChunk: {
    */
   <A>(u: Iterable<A>): u is Chunk<A>
   /**
-   * Checks if `u` is a `Chunk<unknown>`
+   * Checks whether `u` is a `Chunk<unknown>`
    *
    * **Example** (Checking for chunks)
    *
@@ -580,7 +580,15 @@ const reverseChunk = <A>(self: Chunk<A>): Chunk<A> => {
 
 /**
  * Reverses the order of elements in a `Chunk`.
- * Importantly, if the input chunk is a `NonEmptyChunk`, the reversed chunk will also be a `NonEmptyChunk`.
+ *
+ * **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)
  *
@@ -599,7 +607,8 @@ const reverseChunk = <A>(self: Chunk<A>): Chunk<A> => {
 export const reverse: <S extends Chunk<any>>(self: S) => Chunk.With<S, Chunk.Infer<S>> = reverseChunk as any
 
 /**
- * This function provides a safe way to read a value at a particular index from a `Chunk`.
+ * Gets the value at an index in a `Chunk` safely, returning `None` when the index is
+ * out of bounds.
  *
  * **Example** (Accessing elements safely)
  *
@@ -622,7 +631,8 @@ export const reverse: <S extends Chunk<any>>(self: S) => Chunk.With<S, Chunk.Inf
  */
 export const get: {
   /**
-   * This function provides a safe way to read a value at a particular index from a `Chunk`.
+   * Gets the value at an index in a `Chunk` safely, returning `None` when the index is
+   * out of bounds.
    *
    * **Example** (Accessing elements safely)
    *
@@ -645,7 +655,8 @@ export const get: {
    */
   (index: number): <A>(self: Chunk<A>) => Option<A>
   /**
-   * This function provides a safe way to read a value at a particular index from a `Chunk`.
+   * Gets the value at an index in a `Chunk` safely, returning `None` when the index is
+   * out of bounds.
    *
    * **Example** (Accessing elements safely)
    *
@@ -674,7 +685,8 @@ export const get: {
 )
 
 /**
- * Wraps an array into a chunk without copying, unsafe on mutable arrays
+ * Wraps an array into a chunk without copying, so mutating the source array can
+ * mutate the chunk.
  *
  * **Example** (Creating chunks without copying arrays)
  *
@@ -697,7 +709,8 @@ export const fromArrayUnsafe = <A>(self: ReadonlyArray<A>): Chunk<A> =>
   self.length === 0 ? empty() : self.length === 1 ? of(self[0]) : makeChunk({ _tag: "IArray", array: self })
 
 /**
- * Wraps an array into a chunk without copying, unsafe on mutable arrays
+ * Wraps a non-empty array into a non-empty chunk without copying, so mutating
+ * the source array can mutate the chunk.
  *
  * **Example** (Creating non-empty chunks without copying arrays)
  *
@@ -813,6 +826,11 @@ export const getUnsafe: {
 /**
  * Appends the specified element to the end of the `Chunk`.
  *
+ * **When to use**
+ *
+ * Use to add one element after the existing elements and get a non-empty
+ * result.
+ *
  * **Example** (Appending an element)
  *
  * ```ts
@@ -828,6 +846,9 @@ export const getUnsafe: {
  * 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 concatenating
  * @since 2.0.0
  */
@@ -835,6 +856,11 @@ export const append: {
   /**
    * Appends the specified element to the end of the `Chunk`.
    *
+   * **When to use**
+   *
+   * Use to add one element after the existing elements and get a non-empty
+   * result.
+   *
    * **Example** (Appending an element)
    *
    * ```ts
@@ -850,6 +876,9 @@ export const append: {
    * 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 concatenating
    * @since 2.0.0
    */
@@ -857,6 +886,11 @@ export const append: {
   /**
    * Appends the specified element to the end of the `Chunk`.
    *
+   * **When to use**
+   *
+   * Use to add one element after the existing elements and get a non-empty
+   * result.
+   *
    * **Example** (Appending an element)
    *
    * ```ts
@@ -872,6 +906,9 @@ export const append: {
    * 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 concatenating
    * @since 2.0.0
    */
@@ -879,7 +916,7 @@ export const append: {
 } = dual(2, <A, A2>(self: Chunk<A>, a: A2): NonEmptyChunk<A | A2> => appendAll(self, of(a)))
 
 /**
- * Prepend an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
+ * Prepends an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
  *
  * **Example** (Prepending an element)
  *
@@ -901,7 +938,7 @@ export const append: {
  */
 export const prepend: {
   /**
-   * Prepend an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
+   * Prepends an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
    *
    * **Example** (Prepending an element)
    *
@@ -923,7 +960,7 @@ export const prepend: {
    */
   <B>(elem: B): <A>(self: Chunk<A>) => NonEmptyChunk<B | A>
   /**
-   * Prepend an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
+   * Prepends an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
    *
    * **Example** (Prepending an element)
    *
@@ -1353,6 +1390,11 @@ export const prependAll: {
  * 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
@@ -1367,6 +1409,9 @@ export const prependAll: {
  * // [ 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 concatenating
  * @since 2.0.0
  */
@@ -1375,6 +1420,11 @@ export const appendAll: {
    * 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
@@ -1389,6 +1439,9 @@ export const appendAll: {
    * // [ 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 concatenating
    * @since 2.0.0
    */
@@ -1397,6 +1450,11 @@ export const appendAll: {
    * 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
@@ -1411,6 +1469,9 @@ export const appendAll: {
    * // [ 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 concatenating
    * @since 2.0.0
    */
@@ -1419,6 +1480,11 @@ export const appendAll: {
    * 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
@@ -1433,6 +1499,9 @@ export const appendAll: {
    * // [ 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 concatenating
    * @since 2.0.0
    */
@@ -1441,6 +1510,11 @@ export const appendAll: {
    * 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
@@ -1455,6 +1529,9 @@ export const appendAll: {
    * // [ 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 concatenating
    * @since 2.0.0
    */
@@ -1472,6 +1549,11 @@ export const appendAll: {
      * 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
@@ -1486,6 +1568,9 @@ export const appendAll: {
      * // [ 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 concatenating
      * @since 2.0.0
      */
@@ -1830,7 +1915,7 @@ export const filterMapWhile: {
 })
 
 /**
- * Filter out optional values
+ * Filters out optional values
  *
  * **Example** (Compacting optional values)
  *
@@ -2132,6 +2217,20 @@ export const flatten: <S extends Chunk<Chunk<any>>>(self: S) => Chunk.Flatten<S>
 /**
  * Groups elements in chunks of up to `n` elements.
  *
+ * **When to use**
+ *
+ * Use to divide a chunk into ordered, non-overlapping batches 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
@@ -2150,6 +2249,8 @@ export const flatten: <S extends Chunk<Chunk<any>>>(self: S) => Chunk.Flatten<S>
  * // [[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
  */
@@ -2157,6 +2258,20 @@ export const chunksOf: {
   /**
    * Groups elements in chunks of up to `n` elements.
    *
+   * **When to use**
+   *
+   * Use to divide a chunk into ordered, non-overlapping batches 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
@@ -2175,6 +2290,8 @@ export const chunksOf: {
    * // [[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
    */
@@ -2182,6 +2299,20 @@ export const chunksOf: {
   /**
    * Groups elements in chunks of up to `n` elements.
    *
+   * **When to use**
+   *
+   * Use to divide a chunk into ordered, non-overlapping batches 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
@@ -2200,6 +2331,8 @@ export const chunksOf: {
    * // [[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
    */
@@ -2357,7 +2490,7 @@ export const isEmpty = <A>(self: Chunk<A>): boolean => self.length === 0
 export const isNonEmpty = <A>(self: Chunk<A>): self is NonEmptyChunk<A> => self.length > 0
 
 /**
- * Returns the first element of this chunk if it exists.
+ * Returns the first element of this chunk safely if it exists.
  *
  * **Example** (Getting the first element)
  *
@@ -2424,7 +2557,7 @@ export const headUnsafe = <A>(self: Chunk<A>): A => getUnsafe(self, 0)
 export const headNonEmpty: <A>(self: NonEmptyChunk<A>) => A = headUnsafe
 
 /**
- * Returns the last element of this chunk if it exists.
+ * Returns the last element of this chunk safely if it exists.
  *
  * **Example** (Getting the last element)
  *
@@ -2723,7 +2856,7 @@ export const map: {
     fromArrayUnsafe(pipe(toReadonlyArray(self), RA.map((a, i) => f(a, i)))))
 
 /**
- * Statefully maps over the chunk, producing new elements of type `B`.
+ * Maps over the chunk statefully, producing new elements of type `B`.
  *
  * **Example** (Mapping with accumulated state)
  *
@@ -2754,7 +2887,7 @@ export const map: {
  */
 export const mapAccum: {
   /**
-   * Statefully maps over the chunk, producing new elements of type `B`.
+   * Maps over the chunk statefully, producing new elements of type `B`.
    *
    * **Example** (Mapping with accumulated state)
    *
@@ -2785,7 +2918,7 @@ export const mapAccum: {
    */
   <S, A, B>(s: S, f: (s: S, a: A) => readonly [S, B]): (self: Chunk<A>) => [S, Chunk<B>]
   /**
-   * Statefully maps over the chunk, producing new elements of type `B`.
+   * Maps over the chunk statefully, producing new elements of type `B`.
    *
    * **Example** (Mapping with accumulated state)
    *
@@ -2963,7 +3096,7 @@ export const separate = <A, B>(self: Chunk<Result<B, A>>): [Chunk<A>, Chunk<B>]
 export const size = <A>(self: Chunk<A>): number => self.length
 
 /**
- * Sort the elements of a Chunk in increasing order, creating a new Chunk.
+ * Sorts the elements of a `Chunk` in increasing order, creating a new `Chunk`.
  *
  * **Example** (Sorting chunks)
  *
@@ -2989,7 +3122,7 @@ export const size = <A>(self: Chunk<A>): number => self.length
  */
 export const sort: {
   /**
-   * Sort the elements of a Chunk in increasing order, creating a new Chunk.
+   * Sorts the elements of a `Chunk` in increasing order, creating a new `Chunk`.
    *
    * **Example** (Sorting chunks)
    *
@@ -3015,7 +3148,7 @@ export const sort: {
    */
   <B>(O: Order.Order<B>): <A extends B>(self: Chunk<A>) => Chunk<A>
   /**
-   * Sort the elements of a Chunk in increasing order, creating a new Chunk.
+   * Sorts the elements of a `Chunk` in increasing order, creating a new `Chunk`.
    *
    * **Example** (Sorting chunks)
    *
@@ -3046,7 +3179,7 @@ export const sort: {
 )
 
 /**
- * Sorts the elements of a Chunk based on a projection function.
+ * Sorts the elements of a `Chunk` based on a projection function.
  *
  * **Example** (Sorting chunks by a derived value)
  *
@@ -3080,7 +3213,7 @@ export const sort: {
  */
 export const sortWith: {
   /**
-   * Sorts the elements of a Chunk based on a projection function.
+   * Sorts the elements of a `Chunk` based on a projection function.
    *
    * **Example** (Sorting chunks by a derived value)
    *
@@ -3114,7 +3247,7 @@ export const sortWith: {
    */
   <A, B>(f: (a: A) => B, order: Order.Order<B>): (self: Chunk<A>) => Chunk<A>
   /**
-   * Sorts the elements of a Chunk based on a projection function.
+   * Sorts the elements of a `Chunk` based on a projection function.
    *
    * **Example** (Sorting chunks by a derived value)
    *
@@ -3548,7 +3681,7 @@ export const splitWhere: {
 })
 
 /**
- * Returns every elements after the first.
+ * Returns every element after the first safely, or `None` when the chunk is empty.
  *
  * **Example** (Getting the tail safely)
  *
@@ -3571,7 +3704,7 @@ export const splitWhere: {
 export const tail = <A>(self: Chunk<A>): O.Option<Chunk<A>> => self.length > 0 ? O.some(drop(self, 1)) : O.none()
 
 /**
- * Returns every elements after the first.
+ * Returns every element after the first from a non-empty chunk.
  *
  * **Example** (Getting the tail of a non-empty chunk)
  *
@@ -4135,7 +4268,7 @@ export const zip: {
 )
 
 /**
- * Delete the element at the specified index, creating a new `Chunk`.
+ * Deletes the element at the specified index, creating a new `Chunk`.
  *
  * **Example** (Removing an element)
  *
@@ -4160,7 +4293,7 @@ export const zip: {
  */
 export const remove: {
   /**
-   * Delete the element at the specified index, creating a new `Chunk`.
+   * Deletes the element at the specified index, creating a new `Chunk`.
    *
    * **Example** (Removing an element)
    *
@@ -4185,7 +4318,7 @@ export const remove: {
    */
   (i: number): <A>(self: Chunk<A>) => Chunk<A>
   /**
-   * Delete the element at the specified index, creating a new `Chunk`.
+   * Deletes the element at the specified index, creating a new `Chunk`.
    *
    * **Example** (Removing an element)
    *
@@ -4215,7 +4348,7 @@ export const remove: {
 )
 
 /**
- * Applies a function to the element at the specified index, creating a new `Chunk`,
+ * 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)
@@ -4241,7 +4374,7 @@ export const remove: {
  */
 export const modify: {
   /**
-   * Applies a function to the element at the specified index, creating a new `Chunk`,
+   * 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)
@@ -4267,7 +4400,7 @@ export const modify: {
    */
   <A, B>(i: number, f: (a: A) => B): (self: Chunk<A>) => O.Option<Chunk<A | B>>
   /**
-   * Applies a function to the element at the specified index, creating a new `Chunk`,
+   * 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)
@@ -4299,7 +4432,7 @@ export const modify: {
 )
 
 /**
- * Change the element at the specified index, creating a new `Chunk`,
+ * 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)
@@ -4325,7 +4458,7 @@ export const modify: {
  */
 export const replace: {
   /**
-   * Change the element at the specified index, creating a new `Chunk`,
+   * 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)
@@ -4351,7 +4484,7 @@ export const replace: {
    */
   <B>(i: number, b: B): <A>(self: Chunk<A>) => O.Option<Chunk<B | A>>
   /**
-   * Change the element at the specified index, creating a new `Chunk`,
+   * 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)
@@ -4750,7 +4883,7 @@ export const findFirst: {
 } = RA.findFirst
 
 /**
- * Return the first index for which a predicate holds.
+ * Returns the first index for which a predicate holds.
  *
  * **Example** (Finding the first matching index)
  *
@@ -4775,7 +4908,7 @@ export const findFirst: {
  */
 export const findFirstIndex: {
   /**
-   * Return the first index for which a predicate holds.
+   * Returns the first index for which a predicate holds.
    *
    * **Example** (Finding the first matching index)
    *
@@ -4800,7 +4933,7 @@ export const findFirstIndex: {
    */
   <A>(predicate: Predicate<A>): (self: Chunk<A>) => O.Option<number>
   /**
-   * Return the first index for which a predicate holds.
+   * Returns the first index for which a predicate holds.
    *
    * **Example** (Finding the first matching index)
    *
@@ -4830,7 +4963,7 @@ export const findFirstIndex: {
 )
 
 /**
- * Find the last element for which a predicate holds.
+ * Finds the last element for which a predicate holds.
  *
  * **Example** (Finding the last matching element)
  *
@@ -4856,7 +4989,7 @@ export const findFirstIndex: {
  */
 export const findLast: {
   /**
-   * Find the last element for which a predicate holds.
+   * Finds the last element for which a predicate holds.
    *
    * **Example** (Finding the last matching element)
    *
@@ -4882,7 +5015,7 @@ export const findLast: {
    */
   <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): (self: Chunk<A>) => Option<B>
   /**
-   * Find the last element for which a predicate holds.
+   * Finds the last element for which a predicate holds.
    *
    * **Example** (Finding the last matching element)
    *
@@ -4908,7 +5041,7 @@ export const findLast: {
    */
   <A>(predicate: Predicate<NoInfer<A>>): (self: Chunk<A>) => Option<A>
   /**
-   * Find the last element for which a predicate holds.
+   * Finds the last element for which a predicate holds.
    *
    * **Example** (Finding the last matching element)
    *
@@ -4934,7 +5067,7 @@ export const findLast: {
    */
   <A, B extends A>(self: Chunk<A>, refinement: Refinement<A, B>): Option<B>
   /**
-   * Find the last element for which a predicate holds.
+   * Finds the last element for which a predicate holds.
    *
    * **Example** (Finding the last matching element)
    *
@@ -4962,7 +5095,7 @@ export const findLast: {
 } = RA.findLast
 
 /**
- * Return the last index for which a predicate holds.
+ * Returns the last index for which a predicate holds.
  *
  * **Example** (Finding the last matching index)
  *
@@ -4987,7 +5120,7 @@ export const findLast: {
  */
 export const findLastIndex: {
   /**
-   * Return the last index for which a predicate holds.
+   * Returns the last index for which a predicate holds.
    *
    * **Example** (Finding the last matching index)
    *
@@ -5012,7 +5145,7 @@ export const findLastIndex: {
    */
   <A>(predicate: Predicate<A>): (self: Chunk<A>) => O.Option<number>
   /**
-   * Return the last index for which a predicate holds.
+   * Returns the last index for which a predicate holds.
    *
    * **Example** (Finding the last matching index)
    *
@@ -5042,7 +5175,7 @@ export const findLastIndex: {
 )
 
 /**
- * Check if a predicate holds true for every `Chunk` element.
+ * Checks whether a predicate holds true for every `Chunk` element.
  *
  * **Example** (Checking every element)
  *
@@ -5070,7 +5203,7 @@ export const findLastIndex: {
  */
 export const every: {
   /**
-   * Check if a predicate holds true for every `Chunk` element.
+   * Checks whether a predicate holds true for every `Chunk` element.
    *
    * **Example** (Checking every element)
    *
@@ -5098,7 +5231,7 @@ export const every: {
    */
   <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): (self: Chunk<A>) => self is Chunk<B>
   /**
-   * Check if a predicate holds true for every `Chunk` element.
+   * Checks whether a predicate holds true for every `Chunk` element.
    *
    * **Example** (Checking every element)
    *
@@ -5126,7 +5259,7 @@ export const every: {
    */
   <A>(predicate: Predicate<A>): (self: Chunk<A>) => boolean
   /**
-   * Check if a predicate holds true for every `Chunk` element.
+   * Checks whether a predicate holds true for every `Chunk` element.
    *
    * **Example** (Checking every element)
    *
@@ -5154,7 +5287,7 @@ export const every: {
    */
   <A, B extends A>(self: Chunk<A>, refinement: Refinement<A, B>): self is Chunk<B>
   /**
-   * Check if a predicate holds true for every `Chunk` element.
+   * Checks whether a predicate holds true for every `Chunk` element.
    *
    * **Example** (Checking every element)
    *
@@ -5188,7 +5321,7 @@ export const every: {
 )
 
 /**
- * Check if a predicate holds true for some `Chunk` element.
+ * Checks whether a predicate holds true for some `Chunk` element.
  *
  * **Example** (Checking for some matching element)
  *
@@ -5213,7 +5346,7 @@ export const every: {
  */
 export const some: {
   /**
-   * Check if a predicate holds true for some `Chunk` element.
+   * Checks whether a predicate holds true for some `Chunk` element.
    *
    * **Example** (Checking for some matching element)
    *
@@ -5238,7 +5371,7 @@ export const some: {
    */
   <A>(predicate: Predicate<NoInfer<A>>): (self: Chunk<A>) => self is NonEmptyChunk<A>
   /**
-   * Check if a predicate holds true for some `Chunk` element.
+   * Checks whether a predicate holds true for some `Chunk` element.
    *
    * **Example** (Checking for some matching element)
    *