Attain - v0.9.4 - Website

A middleware web framework for Deno which is using http standard library inspired by express and Oak. Fast and stable with proper memory usage.

Only for Deno

Download and use

import { App, Router, Request, Response } from "https://deno.land/x/attain/mod.ts";
import { App, Router, Request, Response } from "https://deno.land/x/attain@0.9.4/mod.ts";
// or
import { App, Router, Request, Response } from "https://raw.githubusercontent.com/aaronwlee/Attain/master/mod.ts";

# deno run --allow-net main.ts

Getting Start
- Procedure explain
How To
Boilerplate
Methods and Properies
- Response
- Request
- Router
- App
Nested Routing
Extra plugins
Performance

Getting Start

import { App, Request, Response } from "https://deno.land/x/attain/mod.ts";

const app = new App();

const sampleMiddleware = (req: Request, res: Response) => {
  console.log("before send")
};

app.get("/:id", (req, res) => {
  console.log(req.params);
  res.status(200).send(`id: ${req.params.id}`);
})

app.use(sampleMiddleware, (req, res) => {
  res.status(200).send({status: "Good"});
});

app.listen({ port: 3500 });

console.log("http://localhost:3500");

Procedure explain

The middleware process the function step by step based on registered order.

import { App } from "https://deno.land/x/attain/mod.ts";

const app = new App();

const sleep = (time: number) => {
  return new Promise(resolve => setTimeout(() => resolve(), time)
};

app.use((req, res) => {
  console.log("First step");
}, async (req, res) => {
  await sleep(2000); // the current request procedure will stop here for two seconds.
  console.log("Second step");
});

app.use((req, res) => {
  // pend a job
  res.pend((afterReq, afterRes) => {
    console.log("Fourth step");
    console.log("Fifth step with error");
    console.log("You can finalize your procedure right before respond.")
    console.log("For instance, add a header or caching.")
  })
})

// last step
app.use("/", (req, res) => {
  console.log("Third step with GET '/'");
  // this is the end point
  res.status(200).send({status: "Good"});
});

app.use("/", (req, res) => {
  console.log("Will not executed");
});

app.get("/error", (req, res) => {
  console.log("Third step with GET '/error'");
  throw new Error("I have error!")
})

app.error((err, req, res) => {
  console.log("Fourth step with error");
  console.log("A sequence of error handling.", err)
  res.status(500).send("Critical error.");
})

app.listen({ port: 3500 });

console.log("http://localhost:3500");

How To

Web Socket Example

Auto Recovery

Boilerplate

A Deno web boilerplate by burhanahmeed

Methods and Properies

Response

Methods Getter

getResponse(): AttainResponse
Get current response object, It will contain the body, status and headers.
headers(): Headers
Get current header map
getStatus(): number | undefined
Get current status
getBody(): Uint8Array
Get current body contents

Functions

pend(...fn: CallBackType[]): void
Pend the jobs. It'll start right before responding.
status(status: number)
Set status number
body(body: ContentsType)
Set body. Allows setting Uint8Array, Deno.Reader, string, object, boolean. This will not respond.
setHeaders(headers: Headers)
You can overwrite the response header.
getHeader(name: string)
Get a header from the response by key name.
setHeader(name: string, value: string)
Set a header.
setContentType(type: string)
This is a shortcut for the "Content-Type" in the header. It will try to find "Content-Type" from the header then set or append the values.
send(contents: ContentsType): Promise<void | this>
Setting the body then executing the end() method.
await sendFile(filePath: string): Promise<void>
Transfers the file at the given path. Sets the Content-Type response HTTP header field based on the filename's extension.
Required to be await
These response headers might be needed to set for fully functioning

Property	Description
maxAge	Sets the max-age property of the Cache-Control header in milliseconds or a string in ms format
root	Root directory for relative filenames.
cacheControl	Enable or disable setting Cache-Control response header.

await download(filePath: string, name?: string): Promise<void>
Transfers the file at the path as an "attachment". Typically, browsers will prompt the user to download and save it as a name if provided.
Required to be await
redirect(url: string | "back")
Redirecting the current response.
end(): Promise<void>
Executing the pended job then respond back to the current request. It'll end the current procedure.

Request

Oak for deno

This method use the Oak request, check this out.

Router

Methods

use(app: App | Router): void
use(callBack: CallBackType): void
use(...callBack: CallBackType[]): void
use(url: string, callBack: CallBackType): void
use(url: string, ...callBack: CallBackType[]): void
use(url: string, app: App | Router): void
get...
post...
put...
patch...
delete...
error(app: App | Router): void;
error(callBack: ErrorCallBackType): void;
error(...callBack: ErrorCallBackType[]): void;
error(url: string, callBack: ErrorCallBackType): void;
error(url: string, ...callBack: ErrorCallBackType[]): void;
error(url: string, app: App | Router): void;
It'll handle the error If thrown from one of the above procedures.

Example

app.use((req, res) => {
  throw new Error("Something wrong!")
})

app.error((error, req, res) => {
  console.error("I handle the Error!" , error);
  res.status(500).send("It's critical!");
})

param(paramName: string, ...callback: ParamCallBackType[]): void;
Parameter handler router.param

Example

const userController = new Router();

userController.param("username", (req, res, username) => {
  const user = await User.findOne({ username: username });
  if (!user) { 
    throw new Error("user not found"); 
  }
  req.profile = user;
})

userController.get("/:username", (req, res) => {
  res.status(200).send({profile: req.profile})
})

userController.post("/:username/follow", (req, res) => {
  const user = await User.findById(req.payload.id);
     if(user.following.indexOf(req.profile._id) === -1){
    user.following.push(req.profile._id);
  }
  const profile = await user.save()
  return res.status(200).send({profile: profile});
})

export default userController;

These are middleware methods and it's like express.js.

App

App extends Router Methods

This has all router's methods

Properties

listen(options)
Start the Attain server.

  options: {
    port: number;             // required
    debug?: boolean;          // debug mode
    hostname?: string;        // hostname default as 0.0.0.0
    secure?: boolean;         // https use
    certFile?: string;        // if secure is true, it's required
    keyFile?: string;         // if secure is true, it's required
  }

Nested Routing

Path - router.ts

warn: async await will block your procedures.

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

const api = new Router();
// or
// const api = new App();

const sleep = (time: number) => {
  new Promise((resolve) => setTimeout(() => resolve(), time));
};

// It will stop here for 1 second.
api.get("/block", async (req, res) => {
  console.log("here '/block'");
  await sleep(1000);
  res.status(200).send(`
  <!doctype html>
  <html lang="en">
    <body>
      <h1>Hello</h1>
    </body>
  </html>
  `);
});

// It will not stop here
api.get("/nonblock", (req, res) => {
  console.log("here '/nonblock'");
  sleep(1000).then(_ => {
      res.status(200).send(`
      <!doctype html>
      <html lang="en">
        <body>
          <h1>Hello</h1>
        </body>
      </html>
      `);
  });
})

export default api;

Path - main.ts

import { App } from "https://deno.land/x/attain/mod.ts";
import api from "./router.ts";

const app = new App();

// nested router applied
app.use("/api", api)

app.use((req, res) => {
  res.status(404).send("page not found");
});

app.listen({ port: 3500 });

console.log("http://localhost:3500");

# start with: deno run -A ./main.ts

Extra plugins

logger : Logging response "response - method - status - path - time"
parser : Parsing the request body and save it to request.params
security: Helping you make secure application by setting various HTTP headers Helmet

Security options

Options	Default?
`xss` (adds some small XSS protections)	yes
`removePoweredBy` (remove the X-Powered-By header)	yes
`DNSPrefetchControl` (controls browser DNS prefetching)	yes
`noSniff` (to keep clients from sniffing the MIME type)	yes
`frameguard` (prevent clickjacking)	yes

staticServe : It'll serve the static files from a provided path by joining the request path.

Out of box

Attain-GraphQL : GraphQL middleware
deno_graphql: GraphQL middleware
session: cookie session
cors: CORS

import { App, logger, parser, security, staticServe } from "https://deno.land/x/attain/mod.ts";

const app = new App();

// Set Extra Security setting
app.use(security());

// Logging response method status path time
app.use(logger);

// Parsing the request body and save it to request.params
// Also, updated to parse the queries from search params
app.use(parser);

// Serve static files
// This path must be started from your command line path.
app.use(staticServe("./public", {maxAge: 1000}));

app.use("/", (req, res) => {
  res.status(200).send("hello");
});

app.use("/google", (req, res) => {
  res.redirect("https://www.google.ca");
})

app.use("/:id", (req, res) => {
  // This data has parsed by the embedded URL parser.
  console.log(req.params);
  res.status(200).send(`id: ${req.params.id}`);
})

app.post("/submit", (req, res) => {
  // By the parser middleware, the body and search query get parsed and saved.
  console.log(req.params);
  console.log(req.query);
  res.status(200).send({ data: "has received" });
});

app.listen({ port: 4000 });
console.log("Start listening on http://localhost:4000");

There are several modules that are directly adapted from other modules. They have preserved their individual licenses and copyrights. All of the modules, including those directly adapted are licensed under the MIT License.

tamasszoke / Attain