A Deno Web Framework Inspired by Oak and Express

Texa

A Deno web-framework inspired by Oak and Express, with built-in support for WebSockets, middleware and routing.

Features

• TLS
• Middlewares
• Router
• WebSockets
• Sleek request & response objects.

Todos

• Cookies.
• Serve static files middleware.

Importing

import { Application, Router } from "https://deno.land/x/texa/mod.ts";

Creating an app

const app = new Application("127.0.0.1:3000");

Disabling WebSockets

const app = new Application("127.0.0.1:3000", {
	allowWebSocket: false
});

WebSockets

app.on("connection", async socket => {
	socket.on("message", async message => {
		// text message
	});
	socket.on("binary", async data => {
		// binary message
	});
	socket.on("ping", async data => {
		// ping event
	});
	socket.on("pong", async data => {
		// pong event
	});
	socket.on("close", async (closer, code, reason) => {
		// Close event
	});
});

Adding middleware

app.use(
	async (req, res, next) => {
		let err: Error | null = null;
		try
		{
			await next();
		} catch (error)
		{
			err = error;
			await res.status(500).end("Internal server error, if you're a developer you can check the server logs.");
		}
		console.log(
			"%s %dms %s%s",                       // The log template.
			req.method,                           // The request method.
			Date.now() - req.at,                  // The amount of ms it took from start to finish.
			res.statusCode,                       // The status code that was sent back.
			req,url.pathname,                     // The requested resource.
			err !== null ? ` - ${err.stack}` : "" // Include an error if an error occured.
		);
	}
);

Creating a router.

const router = new Router();
app.use(router);

Adding routes

router.get("/hello", async (req, res) => {
	await res.end("World");
});

Adding middleware to routers.

router.use(
	async (req, res, next) => {
		// Do something.
		await next();
	}
);

Or only run on a specific path.

router.use(
	"/path",
	async (req, res, next) => {
		res.end(req.url.pathname);
	}
);

Router params

All request methods on the router, or the use method, accepts a path, which can contain a parameter.

router.get("/user/:param", async (req, res) => {
	console.log(req.params);
	// { param: ... }
});

Here are the possible param options.

"/:requiredParam"
"/:requiredParam(withRegex)"
"/:optionalParam?"
"/:optionalParam(withRegex)?"
"/:zeroOrMoreOccurances*"
"/:zeroOrMoreOccurances(withRegex)*"
"/:oneOrMoreOccurances+"
"/:oneOrMoreOccurances(withRegex)+"

Middleware on object.

import { Middleware } from "https://deno.land/x/texa/mod.ts";

class MyMiddleware extends Middleware
{
	public value: string = "World";

	public run: Middleware["run"] = async (req, res, next) => {
		res.headers.set("X-Hello", this.value);
		await next();
	};
}

const middleware = new MyMiddleware();
app.use(middleware);

middleware.value = "Something else now";

HTTP and HTTPS

// Imports
import { Application, Router } from "https://deno.land/x/texa/mod.ts";

// Create application.
const app = new Router();

app.get("/", async (req, res) => {
	res.end("Welcome home!");
});

// Create http app.
const httpApp = new Application("0.0.0.0:80")
	.use(app);

// Create https app.
const httpsApp = new Application("0.0.0.0:443", {
	certFile: "/path/to/cert.pem",
	keyFile: "/path/to/key.pem"
}).use(app);

// Start listening for requests on both servers.
httpApp.start().catch(console.error);
httpApps.start().catch(console.error);

Static files.

// Imports
import { Static } from "https://deno.land/x/texa/mod.ts";

// Use the static middleware.
app.use(
	// Arg 1\. The directory to serve from, relative from <CWD>.
	new Static("www")
);

Custom extension handlers.

app.use(
	new Static("www", {
		handlers: {
			ejs: async (pathname, req, res) => {
				// Compute compiledEJS somehow..
				return [ compiledEJS, "text/html" ];
			}
		}
	})
);

Index files.

app.use(
	new Static("www", {
		indexes: [ "index.html" ]
	})
);

Vanity URLs

You can add extensions to look for just like adding index files.

app.use(
	new Static("www", {
		vanityExtensions: [ "html" ]
	})
);

Download Details:

Author: ihack2712

Source Code: https://github.com/ihack2712/texa

#deno #nodejs #node #javascript