HonoRequest

HonoRequest は Request をラップするオブジェクトで、 c.req からアクセスできます。

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')
  // ...
})

header()

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

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

WARNING

When c.req.header() is called with no arguments, all keys in the returned record are lowercase.

If you want to get the value of a header with an uppercase name, use 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'] is (string | File).

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

複数ファイル

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

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

[] ポストフィックスが必要です。

同じ名前の複数ファイル

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

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

• body['foo'] が複数ファイルだった場合、 (string | File)[] にパースされます。
• body['foo'] が単一ファイルだった場合、 (string | File) にパースされます。

Dot notation

If you set the dot option true, the return value is structured based on the dot notation.

Imagine receiving the following data:

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

You can get the structured value by setting the dot option true:

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

json()

Parses the request body of type 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()

Parses the request body as a Blob.

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

formData()

Parses the request body as a 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()

ハンドラ内で定義されたパスをこのように取得できます:

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

/posts/123 にアクセスしたとき、 /posts/:id が返されます:

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

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

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

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?
  // ...
})