アダプタヘルパー

Adapter Helper は、統一されたインターフェースを通じて様々なプラットフォームとシームレスにやり取りする方法を提供します。

Import

import { Hono } from 'hono'
import { env, getRuntimeKey } from 'hono/adapter'

env()

env() 関数は、 Cloudflare Workers の Bindings にとどまらず、異なるランタイム間で環境変数を取得することを容易にします。 env(c) で取得できる値は、ランタイムごとに異なる場合があります。

import { env } from 'hono/adapter'

app.get('/env', (c) => {
  // NAME is process.env.NAME on Node.js or Bun
  // NAME is the value written in `wrangler.toml` on Cloudflare
  const { NAME } = env<{ NAME: string }>(c)
  return c.text(NAME)
})

サポートされているランタイム、サーバーレスプラットフォーム、クラウドサービス:

• Cloudflare Workers
  • wrangler.toml
  • wrangler.jsonc
• Deno
  • Deno.env
  • .env ファイル
• Bun
  • Bun.env
  • process.env
• Node.js
  • process.env
• Vercel
  • Environment Variables on Vercel
• AWS Lambda
  • Environment Variables on AWS Lambda
• Lambda@Edge
  Lambda の環境変数は Lambda@Edge では サポートされていません 。 代わりに Lambda@Edge イベント を使用する必要があります。
• Fastly Compute
  Fastly Compute では、 ConfigStore を使用してユーザー定義のデータを管理できます。
• Netlify
  Netlify では、 Netlify Contexts を使用してユーザー定義のデータを管理できます。

ランタイムの指定

第2引数にランタイムキーを渡すことで、環境変数を取得するランタイムを指定できます。

app.get('/env', (c) => {
  const { NAME } = env<{ NAME: string }>(c, 'workerd')
  return c.text(NAME)
})

getRuntimeKey()

getRuntimeKey() 関数は、現在のランタイムの識別子を返します。

app.get('/', (c) => {
  if (getRuntimeKey() === 'workerd') {
    return c.text('You are on Cloudflare')
  } else if (getRuntimeKey() === 'bun') {
    return c.text('You are on Bun')
  }
  ...
})

利用可能なランタイムキー

以下は利用可能なランタイムキーの一覧です。 利用できないランタイムキーは、サポートされる可能性があり、 other というラベルが付けられます。 一部のキーは WinterCG's Runtime Keys に着想を得ています:

• workerd - Cloudflare Workers
• deno
• bun
• node
• edge-light - Vercel Edge Functions
• fastly - Fastly Compute
• other - その他の未知のランタイムキー