join-io's Introduction

Join-io

Join files on a fly to reduce requests count.

Install

npm i join-io --save

How it works?

join-io it's middleware that works with streams: open files and pipe them to response one-by-one, when everything is done, stream is closing. join-io based on readPipe function of files-io.

jsDelivr works in similar way: load Multiple files with a single HTTP request.

How to use?

Join-io could be used as express middleware.

Client

<link rel="/join:/css/normilize.css:/css/style.css">
<script src="/join:/lib/client.js:/lib/util.js:/lib/jquery.js"></script>

Join.js

You could build join urls dynamically. Load /join/join.js library for this purpose.

<script src="/join/join.js"></script>
<script>
    join(['lib/client', 'lib/util.js']);
</script>

To decrease requests count you could make /join/join.js part of request:

<script src="/join:/lib/client.js:/lib/util.js:/join/join.js"></script>

Instead of /join you could use any prefix you like (don't forget to set it on the server side).

Server

const join = require('join-io');
const http = require('http');
const express = require('express');

const app = express();
const server = http.createServer(app);

const port = 1337;
const ip = '0.0.0.0';

app.use(join({
    dir: __dirname,
    prefix: '/join',    /* default */
}));

app.use(express.static(__dirname));

server.listen(port, ip);

License

MIT

join-io's People

Contributors

Stargazers

Watchers

join-io's Issues

[Feature Request] Load a list of JavaScript files from a JSON file

In a lot of my past PHP projects, I had a script I wrote that would "include a folder". It did this by first loading a file called jspackage.json in that folder, which listed the paths - ordered, relative to the JSON file - of JavaScript files to be loaded. The the script would combine all this into one clump of JavaScript and send it to the client.

It would be really cool, I think, to bring that same functionality to Express, and this seems like the right module to do so. This is something I might have time to implement in the next couple of weeks.

join-io doesn't work if prefix (other than "join") is passed in options

Stylus issue with Express

Using join-io in an Express project with livecompile of *.styl files everytime server starts build a compressed css without new edits: for view edits in my *.styl files (built into css files) I need to view in a new browser tab the css compiled file (eg: command+t on Chrome, view localhost:3000/css/style.css) and refresh window.

My piece of code where are server settings:

app
  .use(
    stylus.middleware({ 
      src: path.join(__dirname, 'public'), 
      compile: function (str, path) { 
        return stylus(str)
                .set('filename', path)
                .set('compress', true)
                .use(nib());
      } 
    })
  )
  .use(favicon(__dirname + '/public/img/favicon.png'))
  .use(logger('dev'))
  .use(bodyParser.urlencoded({ extended: true }))
  .use(bodyParser.json())
  .use(methodOverride())
  .use(cookieParser('xxx'))
  .use(
    session({
      secret: 'xxx',
      saveUninitialized: true,
      resave: true
    })
  )
  .use(express.static(path.join(__dirname, 'public')))
  .use( joinio({ dir: path.join(__dirname, 'public'), prefix: '/join', minify: true }) )
  .use(errorHandler());

and my jade template css linking

link(rel='stylesheet', href='/join:/font/font_icons8.css:/css/style.css:/css/mobile.css')

Is there a sort of cache or anything related to it?

Thank you!

May accidentally expose internal code

With the default config. I can request any .js file from my server through the \join prefix, ie: http://localhost:3001/join:app.js

app.use(joinio({
    dir: __dirname,
    prefix: '/join',    /* default */
    minify: true
}));

Although I can protect my backend with different dir path, but should this be noticed beforehand?

Recommend Projects

coderaiser / join-io Goto Github PK