Deno

Deno は V8 上に構築された JavaScript ランタイムです。 Node.js ではありません。 Hono は Deno でも動作します。

Hono を使用して TypeScript でコードを書き、 deno コマンドでアプリケーションを起動します。 そして "Deno Deploy" にデプロイ出来ます。

1. Deno のインストール

まず deno コマンドをインストールします。 公式ドキュメント を参照してください。

2. セットアップ

Deno でもスターターを使用できます。 "create-hono" コマンドでプロジェクトを作成してください。

deno run -A npm:create-hono my-app

Select deno template for this example.

my-app に移動しますが、 Deno では Hono を明示的にインストールする必要はありません。

cd my-app

3. Hello World

最初のアプリケーションを書いていきましょう。

import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => c.text('Hello Deno!'))

Deno.serve(app.fetch)

4. Run

このコマンドだけです:

deno task start

ポートを変える

You can specify the port number by updating the arguments of Deno.serve in main.ts:

Deno.serve(app.fetch) 
Deno.serve({ port: 8787 }, app.fetch) 

静的ファイルの提供

静的ファイルを提供するには hono/middleware.ts から serveStatic をインポートして使用します。

import { Hono } from 'hono'
import { serveStatic } from 'hono/deno'

const app = new Hono()

app.use('/static/*', serveStatic({ root: './' }))
app.use('/favicon.ico', serveStatic({ path: './favicon.ico' }))
app.get('/', (c) => c.text('You can access: /static/hello.txt'))
app.get('*', serveStatic({ path: './static/fallback.txt' }))

Deno.serve(app.fetch)

上のコードは、このようなディレクトリ構成で機能します。

./
├── favicon.ico
├── index.ts
└── static
    ├── demo
    │   └── index.html
    ├── fallback.txt
    ├── hello.txt
    └── images
        └── dinotocat.png

rewriteRequestPath

http://localhost:8000/static/* を ./statics にマップしたい場合、 rewriteRequestPath をオプションに追加してください:

app.get(
  '/static/*',
  serveStatic({
    root: './',
    rewriteRequestPath: (path) =>
      path.replace(/^\/static/, '/statics'),
  })
)

mimes

MIME タイプを追加するためには mimes を使用します:

app.get(
  '/static/*',
  serveStatic({
    mimes: {
      m3u8: 'application/vnd.apple.mpegurl',
      ts: 'video/mp2t',
    },
  })
)

onFound

You can specify handling when the requested file is found with onFound:

app.get(
  '/static/*',
  serveStatic({
    // ...
    onFound: (_path, c) => {
      c.header('Cache-Control', `public, immutable, max-age=31536000`)
    },
  })
)

onNotFound

onNotFound を使用して、リクエストされたファイルが見つからない場合の処理を記述できます:

app.get(
  '/static/*',
  serveStatic({
    onNotFound: (path, c) => {
      console.log(`${path} is not found, you access ${c.req.path}`)
    },
  })
)

precompressed

The precompressed option checks if files with extensions like .br or .gz are available and serves them based on the Accept-Encoding header. It prioritizes Brotli, then Zstd, and Gzip. If none are available, it serves the original file.

app.get(
  '/static/*',
  serveStatic({
    precompressed: true,
  })
)

Deno Deploy

Deno Deploy は Deno のためのエッジランタイムプラットフォームです。 Deno Deploy でワールドワイドにアプリケーションを公開できます。

Hono は Deno Deploy もサポートしています。 公式ドキュメントを参照してください。

テスト

Deno でアプリケーションをテストするのは簡単です。 Deno.test と、公式ライブラリの assert か assertEquals を @std/assert からインポートして書いてください。

deno add @std/assert

import { Hono } from 'hono'
import { assertEquals } from '@std/assert'

Deno.test('Hello World', async () => {
  const app = new Hono()
  app.get('/', (c) => c.text('Please test me'))

  const res = await app.request('http://localhost/')
  assertEquals(res.status, 200)
})

次にこのコマンドを実行します:

deno test hello.ts

npm: 指定子

npm:hono is also available. You can use it by fixing the deno.json:

{
  "imports": {
    "hono": "jsr:@hono/hono"
    "hono": "npm:hono"
  }
}

You can use either npm:hono or jsr:@hono/hono.

If you want to use Third-party Middleware such as npm:@hono/zod-validator with the TypeScript Type inferences, you need to use the npm: specifier.

{
  "imports": {
    "hono": "npm:hono",
    "zod": "npm:zod",
    "@hono/zod-validator": "npm:@hono/zod-validator"
  }
}