Miss any of our Open RFC calls?Watch the recordings here! »

@aytacworld/express

2.0.2 • Public • Published

@aytacworld/express

With this module, you don't need to rewrite the express boilerplate over and over again.

Just pass your routes.

Installation

using npm

npm i @aytacworld/express

using yarn

yarn add @aytacworld/express

Usage

router.js

const router = require('express').Router();
 
const Router = (config) => {
  router.get('/', (req, res) => {
    res.render('homepage');
  });
 
  return router;
};
 
module.exports = Router;

app.js

const Express = require('@aytacworld/express');
const config = require('./config');
const app = new Express(config);
 
app.route('/', require('./route'));
 
app.listen();

Config

You can pass some values to change the default behaviour. All values have a default value, and are optional.

{
  "EXPRESS_CORS_DISABLE": true, // Boolean, default: undefined
  "EXPRESS_MORGAN": "tiny", // String, default: combined
  "EXPRESS_PORT": 8080, // Number, default: 3333
  "EXPRESS_PUBLIC_DIR": "./assets", // String, default: path.resolve(require.main.filename, '..', 'public')", which will point to ./public"
  "EXPRESS_VIEWS": "./views", // String, default: path.resolve(__dirname, 'views'), which will point to ./node_modules/@aytacworld/express/views
  "EXPRESS_VIEWS_BASEDIR": "./my-views", // String, default: path.resolve(require.main.filename, '..', 'views'), which will point to the 'views'-folder where the start script is at
  "EXPRESS_DEBUG": true, // Boolean, default: false, this will add more console.logs when running the app
}

Built-in Modules

Logger

This module can be used to log debug/info/warning/error messages. Current version is a wrapper for console, but in future, it will support save to file/db options as well.

Methods

  1. log(...messages): logs debug, you can enable/disable this by setting EXPRESS_DEBUG
  2. info(...messages)
  3. warning(...messages)
  4. error(...messages)

Helper

This module can be used to perform helper functions

Methods

  1. addPathToViewEngine(newPath): this will add new paths to viewEngine
  2. isAuthenticated(): this will check if user is logged in or redirect to login page
  3. setAccessToken(): this will set (bearer) accessToken to request, so it will become accessible, if accessToken doens't exist will send status 401
  4. getUid(length): this will generate a random Uid

Module

You can also pass a module, which will add extra functionality to your app.

app.module(myModule);

Already existing modules

  • logger: built-in module
  • helper: built-in module
  • login

Write your own module

Writing a module for @aytacworld/express is easy. Just return an object with name in it, so this module will be available with that name.

myModule.js

module.exports = (app, config, modules) => {
  return {
    name: 'myAwesomeModule',
    myAwesomeFunction: (a, b) => {
      const c = a + b * config.MY_OWN_CONFIGS;
      return c;
    },
  };
};

anotherModule.js

module.exports = (app, config, modules) => {
  // This module won't be available for other modules loaded after this one, because it doesn't return an object with a name property
  // But it will still be executed
  app.use((req, res, next) => {
    console.log('using my awesome module');
    modules.myAwesomeModule.myAwesomeFunction(4, 6);
    next();
  });
};

or anotherRouter.js

const router = require('express').Router();
 
const Router = (config, modules) => {
  router.get('/', (req, res) => {
    const { a, b } = req.body;
    const mySum = modules.myAwesomeModule.myAwesomeFunction(a, b);
    res.render('homepage', { mySum });
  });
 
  return router;
};
 
module.exports = Router;

How to use it on app.js

const Express = require('@aytacworld/express');
const config = require('./config');
const myModule = require('./myModule.js');
const anotherRouter = require('./anotherRouter.js');
const app = new Express(config);
 
// Module declaration 1
app.module(myModule);
app.module(anotherRouter);
 
// Module declaration 2
app.module(myModule, anotherRouter);
 
app.route('/', require('./anotherRouter'));
 
app.listen();

*module declaration 1 and 2 are the same

MIT License

Copyright (c) 2018 Adem Aytaç

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.

Keywords

none

Install

npm i @aytacworld/express

DownloadsWeekly Downloads

29

Version

2.0.2

License

MIT

Unpacked Size

12.3 kB

Total Files

6

Last publish

Collaborators

  • avatar