Giter Club home page Giter Club logo

express-combo's Introduction

Express Combo

Combo handler for express applications.

Build Status

Goals

  • register and serve static assets from a specific folder
  • register and serve static assets based on an explicit mapping to protect other files that should not be exposed
  • serve combo urls based on the static assets that were registered

Installation

Install using npm:

$ npm install express-combo

Usage

var express = require('express'),
    app = express(),
    statichandler = require('express-combo');

app.get('/static', statichandler.folder('public', 'full/path/to/folder/'));

app.get('/static', statichandler.map('protected', {
    'something/foo.js": "full/path/to/something/foo.js',
    'bar.js": "full/path/to/something/bar.js'
}));

app.get('/static', statichandler.combine({
    comboBase: '/combo~',
    comboSep: '~'
}));

The example above will allow you to access any file within the folder full/path/to/folder/ by following the route:

In this case, serving files without any protection, which means all files could be accessed. Under the hood this is equivalent to use express.static middleware. It also expose two files, but this time adding some explicit mapping for them, exposing:

It protects any other file within the those folders. It also provides a nice abstraction where filenames and paths in the filesystem are not longer relevant when it comes to serve them, and the mapping has to be explicit.

And last, but not least, it turns on the combo capabilities for all the previous registered assets, and doing so by defining the separator token. As a result, a urls like these will be valid:

Note: the /static prefix is optional, and you can remove it all together, and even use app.use() directly for those middleware.

TODO

  • support custom filters (regex) to include and/or exclude assets thru folder and map.
  • css relative path correction when serving thru combo

License

This software is free to use under the Yahoo! Inc. BSD license. See the LICENSE file for license text and copyright information.

Contribute

See the CONTRIBUTE file for info.

express-combo's People

Contributors

caridy avatar imalberto avatar

Watchers

James Cloos avatar acelan 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.