https://github.com/tjosepo/deno_server
Yet another backend framework for Deno 🦕
https://github.com/tjosepo/deno_server
deno
Last synced: about 1 month ago
JSON representation
Yet another backend framework for Deno 🦕
- Host: GitHub
- URL: https://github.com/tjosepo/deno_server
- Owner: tjosepo
- Created: 2021-11-19T15:58:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-11T02:19:46.000Z (over 3 years ago)
- Last Synced: 2025-01-13T05:29:16.566Z (over 1 year ago)
- Topics: deno
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# deno_server
deno_server is a very lightweight web framework. deno_server's main goal are
simplicity, composability and implicitness.
Some key features of deno_server:
- Uses Web Platform APIs instead of using proprietary abstractions.
- There is no "app" or "router" object to manage in your code.
- Uses hooks to allow code to be highly composable.
- Has a tiny API surface.
## Quick start
### Add dependency
```ts
export * from "https://github.com/tjosepo/deno_server/raw/main/mod.ts";
export * from "https://github.com/tjosepo/deno_server/raw/main/plugin/mod.ts";
```
### Start programming
```ts
import { get, serve, useCors, useLogging } from "./deps.ts";
serve(() => {
useLogging();
useCors();
get("/", () => "Hello world!");
});
```
## Documentation
🛣️ Path hook
The _Path_ hook lets you group endpoints together.
```ts
import {
del,
get,
patch,
path,
post,
serve,
} from "https://github.com/tjosepo/deno_server/raw/main/mod.ts";
serve(() => {
get("/hello", () => "Hello world!");
path("/user", () => {
get("/", getAllUsers);
post("/", createUser);
path("/:id", () => {
get("/", getOneUser);
patch("/", updateUser);
del("/", deleteUser);
});
});
}, { port: 8080 });
```
The _Path_ hook can also be used to encapsulate side effects from the _Use_
hook. An effect declared inside a path will only affect endpoints from that path
and it's subpaths.
⚡ Use Hook
The _Use_ hook lets you perform side effects in a reply. It serves the same
purpose as middlewares and guards from other frameworks. Effects are performed
before and after every request.
```ts
import {
get,
serve,
use,
} from "https://github.com/tjosepo/deno_server/raw/main/mod.ts";
serve(() => {
// Similar to middlewares and guards:
use((request) => {
if (request.method !== "GET") {
throw new Response("Method Not Allowed", {
status: 405,
headers: new Headers({ allow: "GET" }),
});
}
});
get("/", () => "Hello world!");
});
```
An effect may return a cleanup function to be performed after the request (even
if an exception occurred). Cleanup functions may be used to view the repsonse
and modify it by giving it additional properties.
```ts
import {
get,
serve,
use,
} from "https://github.com/tjosepo/deno_server/raw/main/mod.ts";
serve(() => {
// Implements a logger
use((request) => {
const start = Date.now();
return ({ response }) => {
const ms = Date.now() - start;
console.log(
`[${response.status}] ${request.method} ${request.url} ${ms}ms`,
);
};
});
get("/", () => "Hello world!");
});
```
Unlike middlewares, **effects cannot modify the request object**. The request
object that a route receives is the request object that was received by the
server. However, effects can interrupt the processing of a request by throwing.
🧪 Testing
You can use the _Mock_ hook to test your components. It returns a special fetch
function that can be used to simulate a request.
```ts
export { assertEquals } from "https://deno.land/std/testing/asserts.ts";
import {
get,
mock,
} from "https://github.com/tjosepo/deno_server/raw/main/mod.ts";
async function test() {
const fetch = mock(() => get("/foo", "Hello world!"));
const response = await fetch("/foo");
assertEquals(await response.text(), "Hello world!");
}
```