超时中间件

超时中间件使您能够轻松地管理应用程序中的请求超时。它允许您设置请求的最大持续时间，并可以选择定义自定义错误响应，如果超过指定的超时时间。

导入

import { Hono } from 'hono'
import { timeout } from 'hono/timeout'

用法

以下是如何使用超时中间件，包括默认设置和自定义设置

默认设置

const app = new Hono()

// Applying a 5-second timeout
app.use('/api', timeout(5000))

// Handling a route
app.get('/api/data', async (c) => {
  // Your route handler logic
  return c.json({ data: 'Your data here' })
})

自定义设置

import { HTTPException } from 'hono/http-exception'

// Custom exception factory function
const customTimeoutException = (context) =>
  new HTTPException(408, {
    message: `Request timeout after waiting ${context.req.headers.get(
      'Duration'
    )} seconds. Please try again later.`,
  })

// for Static Exception Message
// const customTimeoutException = new HTTPException(408, {
//   message: 'Operation timed out. Please try again later.'
// });

// Applying a 1-minute timeout with a custom exception
app.use('/api/long-process', timeout(60000, customTimeoutException))

app.get('/api/long-process', async (c) => {
  // Simulate a long process
  await new Promise((resolve) => setTimeout(resolve, 61000))
  return c.json({ data: 'This usually takes longer' })
})

注意

• 超时的持续时间可以以毫秒为单位指定。如果超过指定的持续时间，中间件将自动拒绝承诺并可能抛出错误。

• 超时中间件不能与流一起使用。因此，请将 stream.close 和 setTimeout 结合使用。

app.get('/sse', async (c) => {
  let id = 0
  let running = true
  let timer: number | undefined

  return streamSSE(c, async (stream) => {
    timer = setTimeout(() => {
      console.log('Stream timeout reached, closing stream')
      stream.close()
    }, 3000) as unknown as number

    stream.onAbort(async () => {
      console.log('Client closed connection')
      running = false
      clearTimeout(timer)
    })

    while (running) {
      const message = `It is ${new Date().toISOString()}`
      await stream.writeSSE({
        data: message,
        event: 'time-update',
        id: String(id++),
      })
      await stream.sleep(1000)
    }
  })
})

中间件冲突

注意中间件的顺序，尤其是在使用错误处理或其他与计时相关的中间件时，因为它可能会影响此超时中间件的行为。