HttpMethod API Reference

Models

HttpMethod

Since v1.0.0

HttpMethod

type

Since v1.0.0

Signature

type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"

Other

all

Since v1.0.0

Signature

declare const all: ReadonlySet<HttpMethod>

hasBody

Since v1.0.0

Signature

declare function hasBody(method: HttpMethod): boolean

Refinements

isHttpMethod

Since v1.0.0

Tests if a value is a HttpMethod.

Signature

declare function isHttpMethod(u: unknown): u is HttpMethod

Example

import { HttpMethod } from "@effect/platform"

console.log(HttpMethod.isHttpMethod("GET"))
// true
console.log(HttpMethod.isHttpMethod("get"))
// false
console.log(HttpMethod.isHttpMethod(1))
// false