Fast, lightweight and zero dependency framework for bunjs 🚀
- Background
- Prerequisite
- Install
- Usage
- Application instance cache
- Error Handler
- Contribute
- License
- Author
- Note
Bun is the lastest and arguably the fastest runtime environment for javascript, similar to node and deno. Bun uses JSC (JavaScriptCore) engine unlike node and deno which is the part of the reason why it's faster then node and deno.
Bun is written in a low-level manual memory management programming language called ZIG.
Bun supports ~90% of the native nodejs APIs including fs, pathetc and also distribute it's packages uses npm hence both yarn and npm are supported in bun.
Colstonjs is a fast, minimal and higly configurable typescript based api framework highly inspired by Expressjs and fastify for building high performance APIs, colstonjs is completely built on bunjs.
🐎 Bun - Bun needs to be installed locally on your development machine.
💻 To install bun head over to the offical website and follow the installation instructions.
🧑💻 To install coltsonjs run
$ bun add colstonjsAlthough colstonjs is distributed under npm, colstonjs is only available for bun, node and deno are not currently supported.
Importing the colstonjs into the application
import Colston from "colstonjs";
// initializing Colston
const serverOptions = {
port: 8000,
env: "development"
};
// initialize app with server options
const app: Colston = new Colston(serverOptions);A simple get request
// server.ts
...
app.get("/", function(ctx) {
return ctx.status(200).text("OK"); // OK
});
...To allow the application to accept requests, we have to call the start() method with an optional
port and/or callback function.
This will start an http sever on the listening on all interfaces (0.0.0.0) listening on the specified port.
// server.ts
...
server.start(port?, cb?);-
portnumber can be passed into theappthrough the server options or the as the first argument of thestart()mthod. If the the port number is passed as part of the server options and also in thestart()mthod, then port number passed into to thestart()takes priority. If no neither is provided, then the app will default to port3000 -
callbackmethod is immediately invoked once the connection is successfully established and the application is ready to accept requests.
// server.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
app.set("port", 8000);
app.get("/", (ctx: Context) => {
return ctx.status(200).json({ message: "Hello World!" });
});
// start the server
app.start(app.get('port'), () => console.log(`server listening on port ${app.get("port")}`));// server.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
app.get("/", async (ctx: Context) => {
const body = await ctx.request.json();
const body2 = await ctx.request.text();
return ctx.status(200).json({ body, body2 });
});
app.start(8000);// server.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
app.get("/user/:id/name/:name", async (ctx: Context) => {
const user = ctx.request.params;
// make an api call to a backend datastore a to retrieve usre details
const userDetails = await getUserDetails(details.id); // e.g: { id: 12345, name: "jane"}
return ctx.status(200).json({ user: userDetails});
});
app.start(8000);// server.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
app.get('/?name&age', async (ctx: Context) => {
const query = ctx.request.query;
return ctx.status(200).json(query); // { name: "jane", age: 50 }
});
app.start(8000);Colstonjs also provide the flexibility of method chaining, create one app instance and chain all methods on that single instance.
// server.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
app
.get("/one", (ctx: Context) => {
return ctx.status(200).text("One");
})
.post("/two", (ctx: Context) => {
return ctx.status(200).text("Two");
})
.patch("/three", (ctx: Context) => {
return ctx.status(200).text("Three");
});
app.start(8000);Colstonjs support both route level middleware as well as app level middleware.
This is a middleware which will be called on each request made to the server, one use case can be for logging.
// logger.ts
export function logger(ctx) {
const { pathname } = new URL(ctx.request.url);
console.info([new Date()], " - - " + ctx.request.method + " " + pathname + " HTTP 1.1" + " - ");
}
// server.ts
import Colston, { type Context } from "colstonjs";
import { logger } from "./logger";
const app: Colston = new Colston({ env: "development" });
// middleware
app.use(logger); // [2022-07-16T01:01:00.327Z] - - GET / HTTP 1.1 -
app.get("/", (ctx: Context) => {
return ctx.status(200).text("Hello logs...");
});
app.start(8000);The .use() accepts k numbers of middleware function.
...
app.use(fn-1, fn-2, fn-3, ..., fn-k)
...Colston on the other hand allows you to add a middleware function in-between the route path and the handler function.
// request-id.ts
export function requestID(ctx) {
ctx.request.id = crypto.randomBytes(18).toString('hex');
}
// server.ts
import crypto from "crypto";
import Colston, { type Context } from "colstonjs";
import { requestID } from "./request-id";
const app: Colston = new Colston({ env: "development" });
app.get("/", requestID, (ctx: Context) => {
return ctx.status(200).text(`id: ${ctx.request.id}`); // id: 410796b6d64e3dcc1802f290dc2f32155c5b
});
app.start(8000);It is also worthy to note that we can also have k numbers of route-level middleware functions
// server.ts
...
app.get("/", middleware-1, middleware-2, middleware-3, ..., middleware-k, (ctx: Context) => {
return ctx.status(200).text(`id: ${ctx.request.id}`);
});
...We can cache simple data which will leave throughout the application instance lifecycle.
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
// set properties to cache
app.set("age", 50);
app.set("name", "jane doe");
// check if a key exists in the cache
app.has("age"); // true
app.has("name"); // true
// retrieve the value stored in a given key
app.get("age"); // 50
app.get("name"); // jane doe
app.start(8000);Errors are handled internally by colstonjs, however this error handler method can aslo be customised.
// index.ts
import Colston, { type Context } from "colstonjs";
const app: Colston = new Colston({ env: "development" });
// a broken route
app.get("/error", (ctx) => {
throw new Error("This is a broken route");
});
// Custom error handler
app.error = async function (error) {
console.error("This is an error...");
return Response.json(JSON.stringify(
// return custom error here
const err = JSON.stringify(error);
new Error(error.message || "An error occurred" + err);
), { status: 500 });
}
app.start(8000);PRs for features, enhancements and bug fixes are welcomed. ✨ You can also look at the todo file for feature contributions. 🙏🏽
This software is distributed under the MIT license.
See the TODO doc here, feel free to also add to the list by editing the TODO file.
Coded with 💙 by Chukwuemeka Ajima
Although this version is fairly stable, it is actively still under development so also is bunjs and might contain some bugs, hence, not ideal for a production app.