perd

PERD

Create your clean, simple, and readable express router only use typescript decorators

Documentation for PERD (Powerful Express Router Decorators)

Installation

NPM

npm install perd

Yarn

yarn add perd

Features

• Robust routing
• Clean and Readable Route

Basic Usage

hello-controller.ts

import { BaseController, ErrorHandler, GET, POST, router } from 'perd'
@router('/hello')
export class HelloController extends BaseController {
  /**
   * you can define your route so simple like this
   * @param data - data that already bundled from `req.params` `req.query`
   */
  @GET('/sayHello/:name')
  async sayHelloWithQuery(data: { name: string }) {
    return `Hello ${data.name}`
  }

  /**
   * if you not provide the path, it will automatically set by
   * the function name `sayHello`
   */
  @GET()
  async sayHello() {
    return 'Hello World'
  }

  @POST('/message')
  async createMessage(data: { message: string }) {
    if (!data.message) {
      // if you want to throw an error just simply throw an error handler
      throw new ErrorHandler(403, "You're not provide the message", true)
    }
  }
}

app.ts

import express from 'express'
import { HelloController } from './controllers'

const app = express()
app.use(HelloController.routers())
app.listen(3000, () => {
  console.log('yeaay!! your express server already running on port ', 3000)
})