Giter VIP home page Giter VIP logo

express-helper's Introduction

Express Helper

Helper functions for building express application

Features

Usage

error-handler

Add custom error handlers.

  • Syntax: errorHandler(...customErrorHandlers)
  const withCustomErrorHandler: ErrorRequestHandler = (...) => {...};
  const withAnotherCustomErrorHandler: ErrorRequestHandler = (...) => {...};

  // should always be placed at the very bottom
  app.use(
    // custom 404 error
    wrapper((request) => {
      throw new BadRequest(`Cannot ${request.method} ${request.path}`);
    }),
    // error handlers
    errorHandler(withCustomErrorHandler, withAnotherCustomErrorHandler)
 );

register-controllers

Automatic register controllers on a selected directory.

  • Syntax: registerControllers(absoluteDirPath, basePath, callback)

Rules:

  • Filename should be in [name].controller.{ts|js} format
    • example: foo.controller.ts
  • Nested directory is allowed
  • If the file named as index.controller, its base path will be based on its location
    • example: src/controllers/foo/bar/index.controller.ts -> http://localhost:3001/foo/bar
const targetDirectory = path.join(__dirname, './controllers');

app.use(registerControllers(targetDirectory));

wrapper

Used in wrapping request handlers that might throw an error, also used in making shorter code by just returning the value itself instead of using the actual response object's method. It also accepts async callbacks. Returns an array, in some cases you can spread it.

  • Syntax: wrapper(...requestHandlers)
const app = express();

app
  .get(
    '/foo',
    wrapper(middlewareThatMightThrowAnError),
    wrapper(function () {
      ...
      if (condition) throw SomeError(message)
      ...
      return 'Hello, World!';
    }, ...)
  );

validate

Validate request object's query, body, or params.

  • Syntax: validate(target, dtoClass)
    • target's valid values are QUERY, BODY, and PARAMS
import { validate, vendors } from '@jmrl23/express-helper';

class UserLoginDto {
  @vendors.classValidator.IsString()
  @vendors.classValidator.Length(1, 30)
  readonly username: string;

  @vendors.classValidator.IsString()
  @vendors.classValidator.Length(1)
  readonly password: string;
}

// usage of `express.json` is required in validating the `request.body`
app.use(express.json());

app.post(
  '/user/login',
  // validate `request.body`
  validate('BODY', UserLoginDto),
  wrapper(function (request) {
    const data = request.body;
    // process data
  }),
);

vendors

Use installed package that may be helpful.

import { vendors } from '@jmrl23/express-helper';

// use `BadRequest` from package `http-errors`
throw new vendors.httpErrors.BadRequest('LOL');

express-helper's People

Contributors

jmrl23 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.