@tsed/platform-router

@tsed/platform-router

Website   •   Getting started   •   Slack   •   Twitter

---

A package of Ts.ED framework. See website: https://tsed.io/

Installation

npm install --save @tsed/platform-router

Usage

This module generates routers from decorated class.

import express from "express";
import {Controller, InjectorService} from "@tsed/di";
import {PlatformHandlerType, PlatformHandlerMetadata, PlatformRouter, PlatformLayer} from "@tsed/platform-router";
import {Delete, Get, Head, Options, Patch, Post, Put} from "@tsed/schema";

@Controller("/nested")
class NestedController {
  @Get("/")
  get() {}

  @Post("/")
  post() {}

  @Put("/:id")
  put() {}

  @Delete("/:id")
  delete() {}

  @Head("/:id")
  head() {}

  @Options("/:id")
  option() {}

  @Patch("/:id")
  patch() {}
}

@Controller({path: "/controller", children: [NestedController]})
@UseBefore(function useBefore() {})
class MyController {
  @Get("/")
  get() {}

  @Post("/")
  post() {}

  @Put("/:id")
  put() {}

  @Delete("/:id")
  delete() {}

  @Head("/:id")
  head() {}

  @Options("/:id")
  option() {}

  @Patch("/:id")
  patch() {}
}

const injector = new InjectorService();

const expressApp = express();

injector.addProvider(MyController);
injector.addProvider(NestedController);

const appRouter = new PlatformRouter(injector);

appRouter.use("/rest", MyController);

// transform handlerMetadata to a compatible handler for the targeted framework (Express.js, Koa.js, etc...)
PlatformRouter.hooks.on("alterHandler", (handlerMetadata: PlatformHandlerMetadata) => {
  if (!handlerMetadata.isInjectable()) {
    return handlerMetadata.handler;
  }

  const handler = this.platformParams.compileHandler(handlerMetadata);

  switch (handlerMetadata.type) {
    case PlatformHandlerType.DEFAULT:
    case PlatformHandlerType.ENDPOINT:
    case PlatformHandlerType.MIDDLEWARE:
      const handler = platformParams.compileHandler(handlerMetadata);

      return (req, res, next) => {
        return handler({$ctx: {next, request: req, response: res}});
      };
    case PlatformHandlerType.ERR_MIDDLEWARE:
      return (error: unknown, req, res, next) => {
        return handler({$ctx: {error, next, request: req, response: res}});
      };
  }
});

// bind layers to the framework router
appRouter.getLayers().forEach((layer: PlatformLayer) => {
  const {method, args} = layer;

  expressApp[method](...layer.args);
});

expressApp.listen(3000);

Contributors

Please read contributing guidelines here.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - 2018 Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.