http-codex
TypeScript icon, indicating that this package has built-in type declarations

0.5.3 • Public • Published

http-codex

A simple library for http status codes, adapted from Go's http package.

Usage

Install

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

Example

import { httpStatus } from 'http-codex'

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

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

import { httpStatus } from 'http-codex/status'

const status = httpStatus.OK // 200

Additional Helpers

isNullBodyStatus

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

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

Note: http-codex/status is smaller because it excludes the statusText() function.

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.

Package Sidebar

Install

npm i http-codex

Weekly Downloads

84

Version

0.5.3

License

MIT

Unpacked Size

34.3 kB

Total Files

19

Last publish

Collaborators

  • jahands