Add isHttpMethod refinement (#4250)

Co-authored-by: Tim <[email protected]>
Effect-TS · Jan 14, 2025 · c9e5e1b · c9e5e1b
1 parent bcc600b
commit c9e5e1b
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/.changeset/long-waves-fetch.md b/.changeset/long-waves-fetch.md
@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+Add isHttpMethod refinement
diff --git a/packages/platform/src/HttpMethod.ts b/packages/platform/src/HttpMethod.ts
@@ -33,3 +33,27 @@ export declare namespace HttpMethod {
  * @since 1.0.0
  */
 export const hasBody = (method: HttpMethod): boolean => method !== "GET" && method !== "HEAD" && method !== "OPTIONS"
+
+/**
+ * @since 1.0.0
+ */
+export const all: ReadonlySet<HttpMethod> = new Set(["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"])
+
+/**
+ * Tests if a value is a `HttpMethod`.
+ *
+ * @param input - The value to test.
+ *
+ * @example
+ * ```ts
+ * import { HttpMethod } from "@effect/platform"
+ *
+ * assert.deepStrictEqual(HttpMethod.isHttpMethod("GET"), true)
+ * assert.deepStrictEqual(HttpMethod.isHttpMethod("get"), false)
+ * assert.deepStrictEqual(HttpMethod.isHttpMethod(1), false)
+ * ```
+ *
+ * @since 1.0.0
+ * @category refinements
+ */
+export const isHttpMethod = (u: unknown): u is HttpMethod => all.has(u as HttpMethod)