HTTP Status Reason Phrases

APIful provides all common HTTP status reason phrases as constants. These are individually typed exports that you can use wherever you need a status phrase instead of hardcoding raw strings.

TIP

You may be wondering, why not use the http-status-codes package directly? Because the enums exported by the package do not work well with frameworks like Hono that use the @hono/zod-openapi type system.

Usage

Import all named exports from apiful/http-status-phrases as a local names, and use them as needed.

import * as HttpStatusPhrases from 'apiful/http-status-phrases'

console.log(HttpStatusPhrases.NOT_FOUND) // 'Not Found'

TIP

With namespace imports, bundlers like Rollup will only include the imported exports in the final bundle, which can help reduce the bundle size.

For web frameworks like Hono, you can use the status phrases in your route handlers like this:

import * as HttpStatusCodes from 'apiful/http-status-codes'
import * as HttpStatusPhrases from 'apiful/http-status-phrases'

app.get('/not-found', (c) => {
  c.status(HttpStatusCodes.NOT_FOUND)
  c.json({ message: HttpStatusPhrases.NOT_FOUND })
})