Skip to content

http_deno_readme.md

Latest commit

 

History

History
83 lines (58 loc) · 2.2 KB

http_deno_readme.md

File metadata and controls

83 lines (58 loc) · 2.2 KB

Overview

http_deno.mjs provides essential tools for HTTP servers running in Deno. The API mirrors http_bun.

  • Tools for serving files (with content type detection) and directories (with optional file filtering / whitelisting / blacklisting).
  • Tools for simple HTML file servers, with automatic matching of "clean" URL paths such as / and /posts to HTML files such as index.html and posts.html.

Also see http for routing and cookies, http_bun for Bun HTTP servers, and http_live for live-reload tools for development.

TOC

Usage

Simple example of a server that serves files from the current directory, automatically matching URL paths to HTML files:

import * as h from '@mitranim/js/http'

// Resolves files relatively to the current folder.
const DIRS = h.HttpDirs.of(new h.HttpDir({fsPath: `.`}))

h.serve({onRequest})

async function onRequest(req) {
  const path = new URL(req.url).pathname

  return (
    (await serveFile(req, path)) ||
    new Response(`not found`, {status: 404})
  )
}

async function serveFile(req, path) {
  const file = await DIRS.resolveSiteFileWithNotFound(path)
  return file?.response()
}

For production, enable compression and caching:

import * as h from '@mitranim/js/http'

const DIRS = h.HttpDirs.of(new h.HttpDir({fsPath: `.`}))
const COMP = new h.HttpCompressor()

DIRS.setOpt({caching: true})

h.serve({onRequest})

async function onRequest(req) {
  const path = new URL(req.url).pathname

  return (
    (await serveFile(req, path)) ||
    new Response(`not found`, {status: 404})
  )
}

async function serveFile(req, path) {
  return h.fileResponse({
    req,
    file: await DIRS.resolveSiteFileWithNotFound(path),
    compressor: COMP,
  })
}

API

Undocumented

The following APIs are exported but undocumented. Check http_deno.mjs.