express-decorated
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.5 • Public • Published

    express-decorated

    express-decorated gives you easy to use decorators to build powerful web APIs with express

    Features

    • Create classes decorated with @Routers and create methods for each @Route.
    • Parse url @Parameters, http @Body, and @Query parameters using decorators.
      • Write self-documenting code by taking advantage of description fields in decorators.
    • Return data directly from your methods, with support for async functions!
      • And specify content-type using @Type.

    Get Started

    Install using yarn.

    yarn add express-decorated

    Or using npm.

    npm install --save express-decorated

    Example usage:

    import express from 'express';
    import { Router, Route, bind } from 'express-decorated';
     
    @Router('/base/url')
    class myRouter {
      @Route('/path/to/route')
      myRoute() {
        return 'hello!'
      }
    }
     
    const app = express();
    bind(app, new myRouter());
    app.listen(1337);

    Navigate to localhost:1337.

    Full example

    A better more expanded example is available here.

    It showcases the different features found in express-decorated and how you can take advantage of them.

    Documenation

    @Router(baseUrl?: string)

    Used to create a router out of a class, this binds several properties along with a method for binding to express.

    Router.enable(app: Express | Router)

    Method on routers used to bind to express, I'd advise using bind() instead as it removes any type errors.

    @Route(path?: string, method?: Method)

    Turns a method into a route, if a path is not specified then this becomes the equivalent of app.use(). The method can be any supported method listed on the expressjs documentation.

    @Type(contentType: string)

    If you plan on returning values from your method, use this to specify the content type.

    @Param(parameter: string, required?: boolean, description?: string)

    Reads a parameter from the request and adds it to your method's arguments. By default it will be required and will throw an error if not present. The description serves as a way to describe your code easily.

    @Body(key: string, required?: boolean, description?: string)

    Reads a value in body from the request and adds it to your method's arguments. By default it will be required and will throw an error if not present. The description serves as a way to describe your code easily.

    @Query(key: string, required?: boolean, description?: string)

    Reads a value in the query parameters from the request and adds it to your method's arguments. By default it will be required and will throw an error if not present. The description serves as a way to describe your code easily.

    Keywords

    none

    Install

    npm i express-decorated

    DownloadsWeekly Downloads

    0

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    17.7 kB

    Total Files

    18

    Last publish

    Collaborators

    • insertish