Skip to content
Miniature in-memory http static middleware optimized for serving buffers or strings
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.gitignore initial commit
.travis.yml wip
README.md add documentation for new stuff
hello.txt simplify tests
index.js fix crash if cache key is not a string
package.json bump (v1.0.5)
pirate_flag.png simplify tests
test.js simplify tests

README.md

dish

miniature in-memory http static middleware optimized for serving buffers or strings

build status

Given a file path, string or buffer, dish will create you an HTTP server request listener, with added benefits:

  • gzip/deflate support
  • ETag / Conditional GET support
  • In-memory LRU cache (faster than accessing the disk for every request)

Install

$ npm install --save dish

Basic usage

To serve a raw string or buffer:

var dish = require('dish')
  , server = require('http').createServer()

server.on('request', dish('hello world!')); // can also accept a Buffer instance
server.listen(3000);

To serve a file (mime-type autodetected from file name)

server.on('request', dish.file('./facepalm.jpg'));

Options

You can pass options as the second parameter to dish().

  • headers (Object) - override / specify headers to send. Be sure to set a Content-Type header if you are serving a string or buffer.
  • status (Number) - status code for the response, defaults to res.statusCode or 200.

Middleware example

var dish = require('dish')
  , middler = require('middler')
  , server = require('http').createServer()

middler(server)
  // a simple "about us" page
  .get('/about', dish.file('./about.html'))
  // Serve a dynamic javascript file with gzip support:
  .get('/my-code.js', function (req, res, next) {
    // create some dynamic javascript...
    var myCode = 'var myNumber = ' + Math.random();
    // serve it
    dish(myCode, {headers: {'Content-Type': 'text/javascript'}})(req, res);
  });

server.listen(3000);

Tweaking the LRU cache

By default, dish uses a 256 MB LRU cache to transparently cache files.

  • To clear a single cache entry, use dish.clearCache(filepath).
  • To clear all cache entries, use dish.clearCache().
  • To set cache options, such as max bytes, use dish.cache.setOptions(options). Supports options that lru-cache supports.
  • To access the cache directly (an lru-cache instance), use dish.cache.backend.
  • To disable the cache, use dish.cache.setOptions({max: 0})


- - -

### Developed by [Terra Eclipse](http://www.terraeclipse.com)
Terra Eclipse, Inc. is a nationally recognized political technology and
strategy firm located in Aptos, CA and Washington, D.C.

- - -

### License: MIT

- Copyright (C) 2012 Carlos Rodriguez (http://s8f.org/)
- Copyright (C) 2012 Terra Eclipse, Inc. (http://www.terraeclipse.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Something went wrong with that request. Please try again.