HonoHonoRequest
The HonoRequest is an object that can be taken from c.req which wraps a Request object.
param()
Get the values of path parameters.
ts
// Captured params
app.get('/entry/:id', (c) => {
const id = c.req.param('id')
...
})
// Get all params at once
app.get('/entry/:id/comment/:commentId', (c) => {
const { id, commentId } = c.req.param()
})// Captured params
app.get('/entry/:id', (c) => {
const id = c.req.param('id')
...
})
// Get all params at once
app.get('/entry/:id/comment/:commentId', (c) => {
const { id, commentId } = c.req.param()
})query()
Get querystring parameters.
ts
// Query params
app.get('/search', (c) => {
const query = c.req.query('q')
...
})
// Get all params at once
app.get('/search', (c) => {
const { q, limit, offset } = c.req.query()
...
})// Query params
app.get('/search', (c) => {
const query = c.req.query('q')
...
})
// Get all params at once
app.get('/search', (c) => {
const { q, limit, offset } = c.req.query()
...
})queries()
Get multiple querystring parameter values, e.g. /search?tags=A&tags=B
ts
app.get('/search', (c) => {
// tags will be string[]
const tags = c.req.queries('tags')
...
})app.get('/search', (c) => {
// tags will be string[]
const tags = c.req.queries('tags')
...
})header()
Get the request header value.
ts
app.get('/', (c) => {
const userAgent = c.req.header('User-Agent')
...
})app.get('/', (c) => {
const userAgent = c.req.header('User-Agent')
...
})parseBody()
Parse Request body of type multipart/form-data or application/x-www-form-urlencoded
ts
app.post('/entry', async (c) => {
const body = await c.req.parseBody()
...
})app.post('/entry', async (c) => {
const body = await c.req.parseBody()
...
})json()
Parse Request body of type application/json
ts
app.post('/entry', async (c) => {
const body = await c.req.json()
...
})app.post('/entry', async (c) => {
const body = await c.req.json()
...
})text()
Parse Request body of type text/plain
ts
app.post('/entry', async (c) => {
const body = await c.req.text()
...
})app.post('/entry', async (c) => {
const body = await c.req.text()
...
})arrayBuffer()
Parse Request body as an ArrayBuffer
ts
app.post('/entry', async (c) => {
const body = await c.req.arrayBuffer()
...
})app.post('/entry', async (c) => {
const body = await c.req.arrayBuffer()
...
})valid()
Get the validated data.
ts
app.post('/posts', (c) => {
const { title, body } = c.req.valid('form')
...
})app.post('/posts', (c) => {
const { title, body } = c.req.valid('form')
...
})Available targets are below.
formjsonqueryheadercookie
See the Validation section for usage examples.
path
The request pathname.
ts
app.get('/about/me', (c) => {
const pathname = c.req.path // `/about/me`
...
})app.get('/about/me', (c) => {
const pathname = c.req.path // `/about/me`
...
})url
The request url strings.
ts
app.get('/about/me', (c) => {
const url = c.req.url // `http://localhost:8787/about/me`
...
})app.get('/about/me', (c) => {
const url = c.req.url // `http://localhost:8787/about/me`
...
})method
The method name of the request.
ts
app.get('/about/me', (c) => {
const method = c.req.method // `GET`
...
})app.get('/about/me', (c) => {
const method = c.req.method // `GET`
...
})raw
The raw Request object.
ts
// For Cloudflare Workers
app.post('/', async (c) => {
const metadata = c.req.raw.cf?.hostMetadata?
...
})// For Cloudflare Workers
app.post('/', async (c) => {
const metadata = c.req.raw.cf?.hostMetadata?
...
})