Giter VIP home page Giter VIP logo

directory-routes's Introduction

Directory Routes

Directory Routes allows you to require modules in a folder deeply and pair all exports with their relative path to the required folder.

What is this good for? We can use this for very cleanly organizing our HTTP endpoints using file/directory structures.

For example let's say we have a folder called routes, and it has this directory structure# Directory Routes Directory Routes allows you to require modules in a folder deeply and map all exports to their full relative path to the required folder.

Installing

npm i -s directory-routes

Example

What is this good for? We can use this for very cleanly organizing our HTTP endpoints using file/directory structures.

For example let's say we have a folder called routes, and it has this directory structure

- routes
  |- auth
  |  |- login.js
  |  |- signup.js
  |  |- logout.js
  |- news
     |- latest.js
     |- between.js

Now if we require the routes directory with Directory Routes like this we can see Directory Routes doing it's magic.

const directoryRoutes = require('directory-routes')
directoryRoutes(__dirname + '/routes', (err, routes) => {
	if (err) return console.log(err)
    console.log(routes)
})

We should now see this from the routes being logged.

[
    ["/auth/login", (login export)],
    ["/auth/signup", (signup export)],
    ["/auth/logout", (logout export)],
    ["/news/latest", (latest export)],
    ["/news/between", (between export)]
]

Additionally, Directory Routes returns a promise that you can use instead of a callback.

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.