https://github.com/nhttp/raptor
Fast router handler for Deno and Deno Deploy
https://github.com/nhttp/raptor
Last synced: about 1 month ago
JSON representation
Fast router handler for Deno and Deno Deploy
- Host: GitHub
- URL: https://github.com/nhttp/raptor
- Owner: nhttp
- License: mit
- Created: 2021-12-23T07:28:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-27T01:33:01.000Z (over 4 years ago)
- Last Synced: 2025-01-11T12:48:46.954Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Raptor
[](http://badges.mit-license.org)
[](https://deno.land/x/raptor)
[](http://makeapullrequest.com)
Fast router handler for [Deno](https://deno.land/) server and
[Deploy](https://deno.com/deploy).
> Raptor implemented to [nhttp](https://nhttp.deno.dev)
## Features
- Middleware support.
- Sub Router support.
## Usage
```ts
import { serve } from "https://deno.land/std@0.118.0/http/server.ts";
import { JsonResponse, raptor } from "https://deno.land/x/raptor@0.0.8/mod.ts";
serve(
raptor()
.make("GET", () => new Response("Hello World"))
.make("GET/hello/:name", (req) => new Response(`Hello ${req.params.name}`))
.make("GET/hello-json", () => new JsonResponse({ name: "raptor" }))
.resolve,
);
console.log("Raptor was here !!");
```
## Run
```bash
deno run --allow-net file.ts
```
and visit `http://localhost:8000` with path `/` or `/hello-json` or
`/hello/yourname`
## Make
Make everything with `raptor().make(verb, ...fns)`.
the verb is =>
`GET | POST | DELETE | PUT | PATCH | OPTIONS | HEAD | ANY | ROUTER | WARE | ERROR | 404`
and path.
### Make Method Handlers
```ts
serve(
raptor()
.make("GET/hello/:name", (req) => new Response(`Hello ${req.params.name}`))
.resolve,
);
```
### Make Global Middleware
```ts
serve(
raptor()
.make("WARE", (req, next) => {
req.foo = "foo";
return next();
})
.make("GET/hello", (req) => new Response(`Hello ${req.foo}`))
.resolve,
);
```
### If Inline Middleware
```ts
serve(
raptor()
.make("GET/hello", (req, next) => {
req.foo = "foo";
return next();
}, (req) => {
return new Response(`Hello ${req.foo}`);
})
.resolve,
);
```
### Make Sub Router
```ts
const router = raptor.createRouter();
router.make("GET/user", () => new Response("Hello from router"));
serve(
raptor()
.make("ROUTER/api/v1", [router])
.resolve,
);
// visit http://localhost:8000/api/v1/user
```
### Make onError
Global error response.
```ts
serve(
raptor()
// example
.make(
"ERROR",
(err, req) => new Response(err.message, { status: err.status || 500 }),
)
.resolve,
);
```
### Make on404
Global 404 response.
```ts
serve(
raptor()
// example
.make("404", (req) => new Response("404 not found url", { status: 404 }))
.resolve,
);
```
[See examples](https://github.com/nhttp/raptor/tree/master/examples)
## License
[MIT](LICENSE)