# http-codex

A simple library for HTTP status codes and methods, adapted from Go's [http package](https://go.dev/src/net/http/status.go).

## Usage

### Install

```shell
# Install using your favorite package manager:
npm install http-codex
pnpm add http-codex
bun add http-codex
yarn add http-codex
```

### Example

```ts
import { httpMethod, httpStatus } from 'http-codex'

const res = new Response('hello world!', {
  status: httpStatus.OK, // 200
  statusText: httpStatus.text(httpStatus.OK) // 'OK'
})

// HTTP methods
const method = httpMethod.GET // 'GET'
```

If preferred, status codes and methods can be imported by themselves to reduce bundle size:

```ts
import { httpMethod } from 'http-codex/method'
import { httpStatus } from 'http-codex/status'

const status = httpStatus.OK // 200
const method = httpMethod.POST // 'POST'
```

### Additional Helpers

#### isNullBodyStatus

Helper function that returns whether the status should have a null body:

```ts
import { httpStatus, isNullBodyStatus } from 'http-codex'

const res = await fetch(url) // Might be 204, 304, etc.
return new Response(isNullBodyStatus(res.status) ? null : res.body, {
  // Useful for when we need to customize response headers/init/etc.
})
```

### Bundle Size

Here are the bundle sizes of each import:

| **Import**          | **Minified** | **Minified + Gzip'd** |
| ------------------- | ------------ | --------------------- |
| `http-codex`        | 4.1 KB       | 1.46 KB               |
| `http-codex/status` | 1.2 KB       | 728 bytes             |
| `http-codex/method` | ~200 bytes   | ~150 bytes            |

Note: `http-codex/status` is smaller because it excludes the `statusText()` function. `http-codex/method` is the smallest as it only contains the HTTP method constants.

## Why Another HTTP Status Code Library?

Honestly I just love Go and wanted one that was very similar to how Go's http package works.