README.md

@srvem/router

A Srvem middleware used to develop routers and server APIs with asynchronous request handlers.

Installation

npm install --save @srvem @srvem/router

Example

import { Context, Srvem } from '@srvem/app'
import { SrvRouter } from '@srvem/router'

// create a Srvem app
const app: Srvem = new Srvem()

// create a SrvRouter and define its routes
const router1: SrvRouter = new SrvRouter()

// GET /greet
router1.get('/greet', async (ctx: Context, next: () => Promise<void>): Promise<void> => {
  ctx.statusCode = 200
  ctx.body = 'Hello, world!'
})

// POST /sample/path/to/somewhere
router1.post('/sample/path/to/somewhere',
  async (ctx: Context, next: () => Promise<void>): Promise<void> => {
    // some code, e.g. route handling response time logger (using `await next()`)
  },
  async (ctx: Context, next: () => Promise<void>): Promise<void> => {
    // more code, e.g. authentication and authorization
  },
  async (ctx: Context, next: () => Promise<void>): Promise<void> => {
    // even more, e.g. actual data response
  }
)

// use router1
app.use(router1)

// listen on port 3000
app.server.listen(3000)

API

import { Context, MiddlewareBlueprint } from '@srvem/app'

import { RouteHandlerType } from './IRoute'



/**
 * Used to develop routers and server APIs with asynchronous request handlers.
 */
declare class SrvRouter extends MiddlewareBlueprint {
  /**
   * Constructs the SrvRouter middleware.
   */
  constructor()

  /**
   * Filters routes by the requests method and URL, then fires thier respective handlers.
   *
   * @param ctx The Context
   */
  main(ctx: Context): Promise<void>

  /**
   * Adds a route and its handler(s).
   *
   * @param method Request method
   * @param path Request path
   * @param handlers Route handler(s)
   */
  addRoute(method: string, path: string, ...handlers: RouteHandlerType[]): void

  /**
   * Adds a route and its handler(s) with nil method.
   *
   * @param path Request path.
   * @param handlers Route handler(s)
   */
  all(path: string, ...handlers: RouteHandlerType[]): void

  /**
   * Adds a route and its handler(s) with GET method.
   *
   * @param path Request path.
   * @param handlers Route handler(s)
   */
  get(path: string, ...handlers: RouteHandlerType[]): void

  /**
   * Adds a route and its handler(s) with POST method.
   *
   * @param path Request path.
   * @param handlers Route handler(s)
   */
  post(path: string, ...handlers: RouteHandlerType[]): void

  /**
   * Adds a route and its handler(s) with PUT method.
   *
   * @param path Request path.
   * @param handlers Route handler(s)
   */
  put(path: string, ...handlers: RouteHandlerType[]): void

  /**
   * Adds a route and its handler(s) with DELETE method.
   *
   * @param path Request path.
   * @param handlers Route handler(s)
   */
  del(path: string, ...handlers: RouteHandlerType[]): void
}



/**
 * Route handler type.
 */
declare type RouteHandlerType = (ctx: Context, next: () => Promise<void>) => Promise<void>;

/**
 * Route type (with its handler(s)).
 */
interface IRoute {
  method: string;
  path: string;
  handlers: RouteHandlerType[];
}

See Also

• @srvem/app - The core package of Srvem (contains a class used to construct a Srvem app).
• @srvem/static - A Srvem middleware used to serve static files from a specified directory.

Credits

Kaleab S. Melkie <[email protected]>

License

MIT License
Copyright © 2017 srvem

Made with ❤ in Addis Ababa.