async-server

Async server

• Async server is a lightweight Express-like framework
• Build with native Node.js HTTP

Getting started

• To create a server, use:

import { Server } from "async-server";

const app = new Server();

• Next, we will register a route called /index and write out "Hello World"

import { Server } from "async-server";

const app = new Server();

class IndexPage {
    async GET(ctx) {
        ctx.response = "Hello world";
    }
}

// Register the route
app.route("/index", new IndexPage());

• Finally listen to localhost and port 80

import { NodeServer } from "async-server";

const app = new Server();

class IndexPage {
    async GET(ctx) {
        ctx.response = "Hello world";
    }
}

// Register the route
app.route("/index", new IndexPage());

// Port default to 8080, host default to localhost, backlog default to 0
await app.listen(80);

• Go to http://localhost:8080/index and you should see the text "Hello World"
• Async server supports chaining so the code above can be shorten:

import { Server } from "async-server";

// Create the server
await new Server()
  // Register the route
  .route("/index", new class IndexPage {
        async GET(ctx) {
            ctx.response = "Hello world";
        }
  })
  // Start the server
  .listen(80);

• To get query and body of a request use ctx.body or ctx.query

• To get the current url use ctx.url

• To get the current request use ctx.request

• Examples: https://github.com/aquapi/async-server-example

JsonDB

• JsonDB is a type of local database which data is stored in a local .json file.
• JsonDB is fast and lightweight

Example

import { JsonDB } from "async-server";

// Create a database
const db = new JsonDB("Your json file path");

// Create a schema called user with `name` property typed `string` and `id` property typed `number`
const User = db.schema("User", {
    name: String,
    id: Number 
});

// Create objects that matched the schema and save it to the database
let user = new User({
    name: "Reve", // Matches type "String"
    id: 863068 // Matches type "Number"
});

await user.save(); // Save to database

let user1 = new User({
    name: "Alex", // Matches type "String"
    id: 509390 // Matches type "Number"
});

await user1.save(); // Save to database

// Search for user with name equals `Alex` and object count set to 1 to returns only 1 object
await User.find({
    name: "Alex"
}, 1).then(console.log);

// Clear all the objects belong to the schema that was created before
await User.clear();

// Clear the database
await db.clear();

• Full docs: https://github.com/aquapi/async-server/tree/main/doc/doc.md

• Important: Don't download Beta or Alpha versions