Overview
Deno is a secure JavaScript/TypeScript runtime built on V8. It runs TypeScript natively without config, is secure by default (explicit permissions required), and is fully compatible with npm packages. Deno 2 adds backwards compatibility with Node.js APIs and package.json, making it a viable drop-in replacement for many Node.js projects. Built-in tooling includes a formatter, linter, test runner, and compiler.
Instructions
- When creating servers, use
Deno.serve()for high-performance HTTP handling with Web Standards Request/Response, and enable parallel workers withdeno serve --parallelfor multi-core utilization. - When configuring security, specify permissions explicitly (
--allow-read,--allow-net,--allow-env) scoped to specific paths, hosts, or variable names. Never deploy with--allow-all. - When managing dependencies, use JSR (
jsr:) for versioned, type-checked packages,npm:specifier for npm packages, and configure import maps indeno.jsonfor clean paths. - When writing tests, use
Deno.test()with@std/assertassertions,@std/testingfor mocking, anddeno test --coveragefor coverage reports. Deno's sanitizers detect resource leaks automatically. - When building CLI tools, use
deno compileto produce standalone executables that cross-compile for Linux, macOS, and Windows with no runtime dependency. - When deploying to the edge, use Deno Deploy with Deno KV for key-value storage,
Deno.cron()for scheduled tasks, and queues for background processing. - When using Deno KV, structure keys hierarchically (
["users", id, "profile"]), useatomic()for transactions, and configure TTL withexpireInfor automatic expiration.
Permissions Model
Deno is secure by default — all external access must be explicitly granted:
| Flag | Grants access to |
|---|---|
--allow-net | Network (fetch, listen) |
--allow-read | File system reads |
--allow-write | File system writes |
--allow-env | Environment variables |
--allow-run | Subprocess execution |
--allow-ffi | Native libraries |
--allow-all or -A | Everything (avoid in prod) |
Fine-grained permissions:
deno run --allow-net=api.stripe.com --allow-read=./data main.ts
npm Compatibility
Import npm packages directly with the npm: prefix:
import express from "npm:express";
import { z } from "npm:zod";
const app = express();
app.get("/", (_req, res) => {
res.json({ message: "Hello from Deno + Express!" });
});
app.listen(3000);
Or declare in deno.json:
{
"imports": {
"express": "npm:express@^4",
"zod": "npm:zod@^3"
}
}
HTTP Server
// Built-in Deno.serve — no imports needed
Deno.serve({ port: 3000 }, async (req: Request) => {
const url = new URL(req.url);
if (url.pathname === "/health") {
return Response.json({ status: "ok" });
}
if (req.method === "POST" && url.pathname === "/echo") {
const body = await req.json();
return Response.json(body);
}
return new Response("Not Found", { status: 404 });
});
Built-in Test Runner
import { assertEquals, assertThrows } from "jsr:@std/assert";
Deno.test("add works correctly", () => {
assertEquals(1 + 2, 3);
});
Deno.test({
name: "async fetch test",
permissions: { net: true },
async fn() {
const res = await fetch("https://httpbin.org/get");
assertEquals(res.status, 200);
},
});
deno test # Run all tests
deno test --watch # Watch mode
deno test --coverage=coverage/ # With coverage
Built-in Tooling
deno fmt # Format code (Prettier-compatible)
deno lint # Lint code
deno check main.ts # Type-check without running
deno compile main.ts # Compile to standalone binary
deno info main.ts # Show module dependency tree
deno.json Configuration
{
"tasks": {
"dev": "deno run --allow-net --allow-read --allow-env --watch src/main.ts",
"test": "deno test --allow-net",
"build": "deno compile --allow-net --allow-read src/main.ts"
},
"imports": {
"zod": "npm:zod@^3",
"@std/assert": "jsr:@std/assert@^1",
"@hono/hono": "jsr:@hono/hono@^4"
},
"lint": { "rules": { "include": ["no-unused-vars"] } },
"fmt": { "useTabs": false, "lineWidth": 100 }
}
Deno Deploy
// main.ts — deploy to Deno Deploy
Deno.serve((req) => {
const { pathname } = new URL(req.url);
if (pathname === "/") {
return new Response("Hello from the edge!");
}
return new Response("Not Found", { status: 404 });
});
deno install -A jsr:@deno/deployctl
deployctl deploy --project=my-project main.ts
Examples
Example 1: Build a REST API with Deno KV
User request: "Create an API with Deno that stores data in Deno KV"
Actions:
- Create HTTP server with
Deno.serve()and route matching - Open KV store with
Deno.openKv()and define key structure - Implement CRUD operations using
kv.get(),kv.set(), andkv.atomic() - Set explicit permissions in
deno.jsontask definitions
Output: A secure API with embedded key-value storage, ready for Deno Deploy.
Example 2: Compile a CLI tool for distribution
User request: "Create a Deno CLI tool that can be distributed as a single binary"
Actions:
- Build the CLI with argument parsing using
@std/cli - Add file and network permissions scoped to required resources
- Write tests with
Deno.test()and run withdeno test - Compile to standalone binaries with
deno compile --targetfor each platform
Output: Cross-platform standalone executables with no runtime dependency.
Guidelines
- Always specify permissions explicitly in production; never deploy with
--allow-all. - Use
deno.jsonimports map for clean import paths instead of raw URLs. - Prefer JSR (
jsr:) over URL imports for versioned, type-checked, immutable packages. - Use
npm:specifier for npm packages directly — no install step needed. - Run
deno fmtanddeno lintin CI for zero-config formatting and linting. - Use
Deno.serve()over third-party frameworks for simple APIs; it is faster and lighter. - Compile to standalone binary with
deno compilefor distribution with no runtime dependency. - Deno 2 is backward-compatible with
package.json— Node.js projects often work without changes. - Use Deno Deploy for serverless edge deployment with zero infrastructure.