Skip to main content
Deno 2 is finally here 🎉️
Learn more

Alosaur 🦖

Alosaur - Deno web framework 🦖.

test

  • Area - these are the modules of your application.
  • Controller - are responsible for controlling the flow of the application execution.
  • Middlware - provide a convenient mechanism for filtering HTTP requests entering your application.
  • Decorators - for query, cookie, parametrs, routes and etc.
  • Dependency Injection - for all controllers by default from microsoft/TSyringe (more about alosaur injection)

Documentation


Simple example:

Controller:

import { Controller, Get, Area, App } from 'https://deno.land/x/alosaur/src/mod.ts';

@Controller('/home')
export class HomeController {
    @Get('/text')
    text() {
        return 'Hello world';
    }
    @Get('/json')
    json() {
        return { text: 'test' };
    }
}

// Declare module
@Area({
    controllers: [HomeController],
})
export class HomeArea {}

// Create alosaur application
const app = new App({
    areas: [HomeArea],
});

app.listen();

tsconfig.app.json:

{
    "compilerOptions": {
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true
    }
}

And run

deno run --allow-net --allow-read --config ./src/tsconfig.app.json app.ts


TODO

  • Add render views: dejs

  • Add return value JSON

  • Add decorators:

    • @Area
    • @QueryParam
    • @Param param from url: /:id
    • @Body
    • @Cookie
    • @Req
    • @Res
    • @Middleware with regex route
    • @Cache Cache to actions {duration: number} number in ms
  • Add middleware

  • Add static middleware (example: app.useStatic)

  • Add CORS middleware

  • Add SPA middleware

  • Add DI

  • Add std exceptions

  • Add CI with minimal tests.

  • Add OpenAPI v3 generator (see /examples/basic/openapi.ts)

  • Add OpenAPI type reference

  • Add GraphQl

  • Add WebSocket

  • Add validators example class-validator

  • Add microservice connector with wasm

  • Add benchmarks

  • Transfer to Alosaur github organization

  • Add docs and more examples

Plugins & modules

Examples

  • Add basic example
  • Add di example
  • Add static serve example
  • Add dejs view render example
  • Add example with sql drivers (postgres)
  • Add basic example in Docker container
  • Add websockets example
  • Add example with wasm

OpenAPI v3

Example in examples/basic/openapi.ts

Generate openAPI file:

deno run -A --config ./src/tsconfig.lib.json examples/basic/openapi.ts

Middlware

You can create middlware and register it in area or all application layer.

@Middlware(new RegExp('/'))
export class Log implements MiddlwareTarget {
    date: Date = new Date();

    onPreRequest(request: ServerRequest, responce: ServerResponse) {
        return new Promise((resolve, reject) => {
            this.date = new Date();
            resolve();
        });
    }

    onPostRequest(request: ServerRequest, responce: ServerResponse) {
        return new Promise((resolve, reject) => {
            console.log(new Date().getTime() - this.date.getTime());
            resolve();
        });
    }
}

Register in app settings

const settings: AppSettings = {
    areas: [HomeArea, InfoArea],
    middlewares: [Log],
};

or in app

const app = new App(settings);

app.use(/\//, new Log());