Allow removing multiple Headers (#4627)

Author: thewilkybarkid

.changeset/wild-melons-scream.md

@@ -0,0 +1,5 @@
+---
+"@effect/platform": minor
+---
+
+Allow removing multiple Headers

packages/platform/src/Headers.ts

@@ -197,14 +197,34 @@ export const merge: {
  * @category combinators
  */
 export const remove: {
-  (key: string): (self: Headers) => Headers
-  (self: Headers, key: string): Headers
+  (key: string | RegExp | ReadonlyArray<string | RegExp>): (self: Headers) => Headers
+  (self: Headers, key: string | RegExp | ReadonlyArray<string | RegExp>): Headers
 } = dual<
-  (key: string) => (self: Headers) => Headers,
-  (self: Headers, key: string) => Headers
+  (key: string | RegExp | ReadonlyArray<string | RegExp>) => (self: Headers) => Headers,
+  (self: Headers, key: string | RegExp | ReadonlyArray<string | RegExp>) => Headers
 >(2, (self, key) => {
   const out = make(self)
-  delete out[key.toLowerCase()]
+  const modify = (key: string | RegExp) => {
+    if (typeof key === "string") {
+      const k = key.toLowerCase()
+      if (k in self) {
+        delete out[k]
+      }
+    } else {
+      for (const name in self) {
+        if (key.test(name)) {
+          delete out[name]
+        }
+      }
+    }
+  }
+  if (Array.isArray(key)) {
+    for (let i = 0; i < key.length; i++) {
+      modify(key[i])
+    }
+  } else {
+    modify(key as string | RegExp)
+  }
   return out
 })
 

packages/platform/test/Headers.test.ts

@@ -151,4 +151,58 @@ describe("Headers", () => {
       })
     })
   })
+
+  describe("remove", () => {
+    it("one key", () => {
+      const headers = Headers.fromInput({
+        "Content-Type": "application/json",
+        "Authorization": "Bearer some-token",
+        "X-Api-Key": "some-key"
+      })
+
+      const removed = Headers.remove(headers, "Authorization")
+
+      deepStrictEqual(
+        removed,
+        Headers.fromInput({
+          "content-type": "application/json",
+          "x-api-key": "some-key"
+        })
+      )
+    })
+
+    it("multiple keys", () => {
+      const headers = Headers.fromInput({
+        "Content-Type": "application/json",
+        "Authorization": "Bearer some-token",
+        "X-Api-Key": "some-key"
+      })
+
+      const removed = Headers.remove(headers, ["Authorization", "authorization", "X-Api-Token", "x-api-key"])
+
+      deepStrictEqual(
+        removed,
+        Headers.fromInput({
+          "content-type": "application/json"
+        })
+      )
+    })
+
+    it("RegExp", () => {
+      const headers = Headers.fromInput({
+        "Authorization": "Bearer some-token",
+        "sec-ret": "some",
+        "sec-ret-2": "some"
+      })
+
+      const removed = Headers.remove(headers, [/^sec-/])
+
+      deepStrictEqual(
+        removed,
+        Headers.fromInput({
+          "authorization": "Bearer some-token"
+        })
+      )
+    })
+  })
 })