eskey-srv's Introduction

eskey-srv

Nodejs micro http server with object notation routing. No extra dependencies are required.

Hello world example:

const EskeyServer = require('./lib/server');
const port = 8080
const app = new EskeyServer();

app.applyRoutes([{ method: 'GET', use: (req, res) => res.end("Hello world") }])

app.listen(port, () => process.stdout.write('Server is listening'));

Routing is based on provided array of routes. Interface of single route presented below:

interface Route {
  children?: Route[] 
  use?: Handler | Handler[],
  method?: string,
  path?: string,
  pathMatchFull?: boolean,
  redirectTo?: string,
}

All properties are optional: more properties filled -> the match will be more precise.

The server extends ClientRequest with params and queryParams. All params should be preceded by colon.

interface ServerResponse extends http.ServerResponse {}

interface ClientRequest extends http.IncomingMessage {
  queryParams: URLSearchParams,
  params: {
    [key: string]: string
  },
}

type Handler = (req: ClientRequest, res: ServerResponse) => any;

With that being said below is more advanced example:

const appRoutes: Route[] = [
  { 
    path: 'api',  use: someMiddleware, children: [
      { 
        path: 'users', children: [
          { 
            path: ':id', children: [
              { method: 'GET', use: usersController.getUser },
              { method: 'DELETE', use: [ usersController.auth, usersController.delete ] }
            ]
          },
          { method: 'GET', use: usersController.list }
        ]
      }
    ]
  },
  { path: '', pathMatchFull: true, use: (req, res) => res.end('Hello world') }
  { use: (_, res) => (res.statusCode=404, res.end()) }
]

const httpServer = http.createServer();
const app = new EskeyServer(appRoutes, httpServer)
  .listen(8080, () => process.stdout.write('Server is listening'))

Nesting paths needs to be accomplished by nesting Route objects with children property. Route.path can't have slash separator. Route handlers are executed sequentially until ServerResponse is finish.

Recommend Projects