Add Array.removeOption and Chunk.removeOption

Author: thewilkybarkid

.changeset/six-pumpkins-yell.md

@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+Add Array.removeOption and Chunk.removeOption

packages/effect/src/Array.ts

@@ -1280,6 +1280,36 @@ export const remove: {
   return out
 })
 
+/**
+ * Delete the element at the specified index, creating a new `Array`,
+ * or return `None` if the index is out of bounds.
+ *
+ * @example
+ * ```ts
+ * import { Array, Option } from "effect"
+ *
+ * const numbers = [1, 2, 3, 4]
+ * const result = Array.removeOption(numbers, 2)
+ * assert.deepStrictEqual(result, Option.some([1, 2, 4]))
+ *
+ * const outOfBoundsResult = Array.removeOption(numbers, 5)
+ * assert.deepStrictEqual(outOfBoundsResult, Option.none())
+ * ```
+ *
+ * @since 3.13.0
+ */
+export const removeOption: {
+  (i: number): <A>(self: Iterable<A>) => Option<Array<A>>
+  <A>(self: Iterable<A>, i: number): Option<Array<A>>
+} = dual(2, <A>(self: Iterable<A>, i: number): Option<Array<A>> => {
+  const out = Array.from(self)
+  if (isOutOfBound(i, out)) {
+    return O.none()
+  }
+  out.splice(i, 1)
+  return O.some(out)
+})
+
 /**
  * Reverse an `Iterable`, creating a new `Array`.
  *

packages/effect/src/Chunk.ts

@@ -1235,6 +1235,17 @@ export const remove: {
   <A>(self: Chunk<A>, i: number): Chunk<A> => unsafeFromArray(RA.remove(toReadonlyArray(self), i))
 )
 
+/**
+ * @since 3.13.0
+ */
+export const removeOption: {
+  (i: number): <A>(self: Chunk<A>) => Option<Chunk<A>>
+  <A>(self: Chunk<A>, i: number): Option<Chunk<A>>
+} = dual(
+  2,
+  <A>(self: Chunk<A>, i: number): Option<Chunk<A>> => O.map(RA.removeOption(toReadonlyArray(self), i), unsafeFromArray)
+)
+
 /**
  * @since 2.0.0
  */

packages/effect/test/Array.test.ts

@@ -452,6 +452,20 @@ describe("Array", () => {
       deepStrictEqual(pipe(new Set([1, 2, 3]), Arr.remove(10)), [1, 2, 3])
     })
 
+    it("removeOption", () => {
+      assertSome(pipe([1, 2, 3], Arr.removeOption(0)), [2, 3])
+      // out of bound
+      assertNone(pipe([], Arr.removeOption(0)))
+      assertNone(pipe([1, 2, 3], Arr.removeOption(-1)))
+      assertNone(pipe([1, 2, 3], Arr.removeOption(10)))
+
+      assertSome(pipe(new Set([1, 2, 3]), Arr.removeOption(0)), [2, 3])
+      // out of bound
+      assertNone(pipe(new Set([]), Arr.removeOption(0)))
+      assertNone(pipe(new Set([1, 2, 3]), Arr.removeOption(-1)))
+      assertNone(pipe(new Set([1, 2, 3]), Arr.removeOption(10)))
+    })
+
     it("reverse", () => {
       deepStrictEqual(Arr.reverse([]), [])
       deepStrictEqual(Arr.reverse([1]), [1])

packages/effect/test/Chunk.test.ts

@@ -116,6 +116,11 @@ describe("Chunk", () => {
     assertEquals(pipe(Chunk.make(1, 2, 3), Chunk.remove(0)), Chunk.make(2, 3))
   })
 
+  it("removeOption", () => {
+    assertNone(pipe(Chunk.empty(), Chunk.removeOption(0)))
+    assertSome(pipe(Chunk.make(1, 2, 3), Chunk.removeOption(0)), Chunk.make(2, 3))
+  })
+
   it("chunksOf", () => {
     assertEquals(pipe(Chunk.empty(), Chunk.chunksOf(2)), Chunk.empty())
     assertEquals(