HonoRequest

HonoRequest は c.req から取得できるオブジェクトで、Request オブジェクトをラップしています。

param()

パスパラメーターの値を取得します。

// Captured params
app
.get
('/entry/:id', async (c
) => {
  const id
 = c
.req
.param
('id')
  // ...
})

// Get all params at once
app
.get
('/entry/:id/comment/:commentId', async (c
) => {
  const { id
, commentId
 } = c
.req
.param
()
})

query()

クエリ文字列のパラメーターを取得します。

// Query params
app
.get
('/search', async (c
) => {
  const query
 = c
.req
.query
('q')
})

// Get all params at once
app
.get
('/search', async (c
) => {
  const { q
, limit
, offset
 } = c
.req
.query
()
})

queries()

クエリ文字列のパラメーターから複数の値を取得します。例：/search?tags=A&tags=B。

app
.get
('/search', async (c
) => {
  // tags will be string[]
  const tags
 = c
.req
.queries
('tags')
  // ...
})

リクエストヘッダーの値を取得します。

app
.get
('/', (c
) => {
  const userAgent
 = c
.req
.header
('User-Agent')
  return c
.text
(`Your user agent is ${userAgent
}`)
})

注意

引数なしで c.req.header() を呼び出すと、返されるレコードのキーはすべて小文字になります。

大文字を含む名前のヘッダーの値を取得する場合は、 c.req.header(“X-Foo”) を使用してください。

// ❌ Will not work
const headerRecord = c.req.header()
const foo = headerRecord['X-Foo']

// ✅ Will work
const foo = c.req.header('X-Foo')

parseBody()

multipart/form-data または application/x-www-form-urlencoded 型のリクエストボディを解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.parseBody
()
  // ...
})

parseBody() は以下の動作に対応しています。

単一のファイル

const body
 = await c
.req
.parseBody
()
const data
 = body
['foo']

body['foo'] の型は (string | File) です。

複数のファイルがアップロードされた場合は、最後のファイルが使用されます。

複数のファイル

const body
 = await c
.req
.parseBody
()
body
['foo[]']

body['foo[]'] の型は常に (string | File)[] です。

[] の接尾辞が必要です。

同じ名前の複数のファイルやフィールド

複数のファイルを選択できる入力欄（<input type="file" multiple />）や、同じ名前の複数のチェックボックス（<input type="checkbox" name="favorites" value="Hono"/>）がある場合は、以下のように扱えます。

const body
 = await c
.req
.parseBody
({ all
: true })
body
['foo']

all オプションはデフォルトでは無効です。

body['foo'] が複数のファイルの場合は、(string | File)[] に解析されます。
body['foo'] が単一のファイルの場合は、(string | File) に解析されます。

ドット記法

dot オプションを true に設定すると、戻り値がドット記法に基づいて構造化されます。

以下のデータを受け取るとします。

const data
 = new FormData
()
data
.append
('obj.key1', 'value1')
data
.append
('obj.key2', 'value2')

dot オプションを true に設定すると、構造化された値を取得できます。

const body
 = await c
.req
.parseBody
({ dot
: true })
// body is `{ obj: { key1: 'value1', key2: 'value2' } }`

json()

application/json 型のリクエストボディを解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.json
()
  // ...
})

text()

text/plain 型のリクエストボディを解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.text
()
  // ...
})

arrayBuffer()

リクエストボディを ArrayBuffer として解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.arrayBuffer
()
  // ...
})

blob()

リクエストボディを Blob として解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.blob
()
  // ...
})

formData()

リクエストボディを FormData として解析します。

app
.post
('/entry', async (c
) => {
  const body
 = await c
.req
.formData
()
  // ...
})

valid()

検証済みのデータを取得します。

app.post('/posts', async (c) => {
  const { title, body } = c.req.valid('form')
  // ...
})

利用できる対象は以下のとおりです。

form
json
query
header
cookie
param

使用例はバリデーションの章を参照してください。

routePath

注意

v4.8.0 で非推奨：このプロパティは非推奨です。代わりにルートヘルパーの routePath() を使用してください。

ハンドラー内で、登録されたパスを以下のように取得できます。

app
.get
('/posts/:id', (c
) => {
  return c
.json
({ path
: c
.req
.routePath
 })
})

/posts/123 にアクセスすると、/posts/:id が返されます。

json

{ "path": "/posts/:id" }

matchedRoutes

注意

v4.8.0 で非推奨：このプロパティは非推奨です。代わりにルートヘルパーの matchedRoutes() を使用してください。

ハンドラー内で、マッチしたルートを返します。デバッグに便利です。

app
.use
(async function logger
(c
, next
) {
  await next
()
  c
.req
.matchedRoutes
.forEach
(({ handler
, method
, path
 }, i
) => {
    const name
 =
      handler
.name
 ||
      (handler
.length
 < 2 ? '[handler]' : '[middleware]')
    console
.log
(
      method
,
      ' ',
      path
,
      ' '.repeat
(Math
.max
(10 - path
.length
, 0)),
      name
,
      i
 === c
.req
.routeIndex
 ? '<- respond from here' : ''
    )
  })
})

path

リクエストのパス名です。

app
.get
('/about/me', async (c
) => {
  const pathname
 = c
.req
.path
 // `/about/me`
  // ...
})

url

リクエストの URL 文字列です。

app
.get
('/about/me', async (c
) => {
  const url
 = c
.req
.url
 // `http://localhost:8787/about/me`
  // ...
})

method

リクエストのメソッド名です。

app
.get
('/about/me', async (c
) => {
  const method
 = c
.req
.method
 // `GET`
  // ...
})

raw

元の Request オブジェクトです。

// For Cloudflare Workers
app.post('/', async (c) => {
  const metadata = c.req.raw.cf?.hostMetadata?
  // ...
})

cloneRawRequest()

HonoRequest から元の Request オブジェクトを複製します。バリデーターや HonoRequest のメソッドがリクエストボディを読み取った後でも使用できます。

import { Hono
 } from 'hono'
const app
 = new Hono
()

import { cloneRawRequest
 } from 'hono/request'
import { validator
 } from 'hono/validator'

app
.post
(
  '/forward',
  validator
('json', (data
) => data
),
  async (c
) => {
    // Clone after validation
    const clonedReq
 = await cloneRawRequest
(c
.req
)
    // Does not throw the error
    await clonedReq
.json
()
    // ...
  }
)

HonoRequest ​

param() ​

query() ​

queries() ​

header() ​

parseBody() ​

複数のファイル ​

同じ名前の複数のファイルやフィールド ​

ドット記法 ​

json() ​

text() ​

arrayBuffer() ​

blob() ​

formData() ​

valid() ​

routePath ​

matchedRoutes ​

path ​

url ​

method ​

raw ​

cloneRawRequest() ​