# `HttpMethod`

An HTTP method a route is written with: `GET`, `POST`, `PUT`, `PATCH` or `DELETE`.

Use it when you record or compare requests, as in a test's `request { }`.

## Shape

One of these 5 values:

| Value | Written |
|---|---|
| `HttpMethod.get` | `GET` |
| `HttpMethod.post` | `POST` |
| `HttpMethod.put` | `PUT` |
| `HttpMethod.patch` | `PATCH` |
| `HttpMethod.delete` | `DELETE` |

## Example

```jadpo
HttpMethod.post
```

`text.parse(raw, as: HttpMethod)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `FETCH`, `HEAD` or `GET `.

## Good to know

- `HEAD` and others that routes aren't written with are refused.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"GET"
"PATCH"
"DELETE"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`HttpMethod` is in the group Web and network, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `GET`, `PATCH` and `DELETE`.

### How it is stored

It is stored in one column named for the field, of type `text`. `PATCH` is stored as `'PATCH'`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `GET` | `GET` |
| `PATCH` | `PATCH` |
| `DELETE` | `DELETE` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>