Cross

A tiny and strong framework for deno web application.

Get started

import { Cross } from "https://deno.land/x/cross/mod.ts";

Shortcut mode

1. Handles all requests.

Cross((ctx) => {
  return ctx.path;
});

1. Creates quick routes.

import { Cross, get, post } from "https://deno.land/x/cross/mod.ts";

Cross(
  get("/:user", (ctx) => {
    return ctx.params;
  }),
  post("/:user", (ctx) => {
    return ctx.params;
  }),
);

1. Starts with options.

import { Cross, get, post } from "https://deno.land/x/cross/mod.ts";

Cross({
        assets: "/static/dir/path",
        port: 3000
    }
    get("/:user", ctx => {
        return ctx.params;
    }),
    post("/:user", ctx => {
        return ctx.params;
    })
);

Note that features such as plugins, middlewares,template engine and unified error handling cannot be used in shortcut mode, you must solve them in other ways.

Decorator mode

If no route is set in the startup parameters, the framework will automatically switch to decorator mode. The only difference in performance between the shortcut mode and the decorator mode is that the latter needs to scan and load all decorators at startup, it is almost the same in runtime.

// index.ts
import { Cross } from "https://deno.land/x/cross/mod.ts";

// If no options, the empty {} is necessary
Cross({});

1. Controller

// controller.ts
import { Context, Controller, Get } from "https://deno.land/x/cross/mod.ts";

@Controller("/prefix")
export class MyController {
  @Get("/:user")
  user(ctx: Context) {
    return ctx.params;
  }
}

2. Middleware

You can add middleware decorator on any class method, including controllers. The role of the middleware parameter is to set the execution priority.

// middleware.ts
import { Context, Middleware } from "https://deno.land/x/cross/mod.ts";

export class MyMiddleware {
  @Middleware(2)
  cors(ctx: Context) {
    // todo something second
  }
  @Middleware(1)
  auth(ctx: Context) {
    // todo something first
  }
}

3. Plugin

Plugin decorators can only be added to classes, and the parameter is the name bound to the context.

// plugin.ts
import { Plugin } from "https://deno.land/x/cross/mod.ts";

@Plugin("redis")
export class Redis {
  constructor() {
    // connect to redis server and create a client
  }
  get(key) {
    // todo something
  }
  set(key, value) {
    // todo something
  }
}

Then you can use redis object as singleton instance in any controllers with ctx.redis.

4. Engine

Define one and only one engine decorator that can render templates file with specific data. The parameter of this decorator is the core method of rendering the template, it accepts two parameters: template file path and rendering data.

// engine.ts
import { Engine } from "https://deno.land/x/cross/mod.ts";

@Engine("render")
export class MyEngine {
  render(tmplFile, data) {
    // return html string
  }
}

5. Template

Template decorator is used to decorate controller handlers, the parameters is template file path. Note that if you don’t define any template engine, this decorator will throw an error.

// controller.ts
import {
  Context,
  Controller,
  Get,
  Template,
} from "https://deno.land/x/cross/mod.ts";

@Controller("/prefix")
export class MyController {
  @Get("/:user")
  @Template("index.tmpl")
  user(ctx: Context) {
    return ctx.params;
  }
}

6. ErrorHandlder

If an error handler decorator is defined, all errors within the framework will be handled by it. Like middleware, you can define it in any class method but only once. This decorator has no parameters.

// error.ts
import { Context, ErrorHandler } from "https://deno.land/x/cross/mod.ts";

export class AnyClass {
  @ErrorHandler
  error(ctx: Context) {
    console.log(ctx.error);
  }
}

API Reference

Instance

To start the web service, you simply call one method Cross({}). Note that not new an instance. The options as follow:

• assets The relative path of static resources directory.
• port HTTP server listening port, default 3000.

Shortcuts

The shortcut methods including all,get,post,put,del,patch,head,opt, and all methods have the same parameters.

• path Route path based on radix tree.
• callback Request handle function.

Decorators

Context

Context is an instance passed to controllers, middlewares and error handler, it contains properties and methods related to requests and responses.

Request Properties

• ctx.params The parameters with route path
• ctx.query The parameters with query string
• ctx.url ex. https://example.com:3000/users?page=1
• ctx.origin ex. https://example.com:3000
• ctx.protocol ex. https:
• ctx.host ex. example.com:3000
• ctx.hostname ex. example.com
• ctx.port ex. 3000
• ctx.path ex. /users
• ctx.method Standard http request methods
• ctx.headers Refer to https://deno.com/deploy/docs/runtime-headers
• ctx.cookies Including one method to get request cookie: ctx.cookies.get(name)
• ctx.body Including five parsing methods: text(), json(), form(), blob(), buffer().

Response Properties

• ctx.status
• ctx.status=
• ctx.statusText
• ctx.statusText=
• ctx.cookies Including two methods to operate response cookie: set(name, value),delete(name)

Response Methods

• ctx.has(name)
• ctx.get(name)
• ctx.set(name, value)
• ctx.append(name, value)
• ctx.delete(name)
• ctx.redirect(url[, status])

Others

• ctx.error
• ctx.throw(message[, status])

Examples

See https://github.com/seatwork/deno-cross/tree/master/examples