Giter Club home page Giter Club logo

node-http-cache's Introduction

unreleased, under development

node-http-cache is a dirt simple in-memory cache for http requests. it has an easy to use API that is exposed through CommonJS and JSON-RPC.

node-http-cache - v0.1.0

Features

  • super fast in-memory http request caching
  • can be used as a CommonJS module in node.js
  • can be used as a standalone server
  • built in JSON-RPC API

When to use node-http-cache

let's suppose you have a web application that serves http requests, by using http-cache you can seamlessly cache the entire site in one line and drastically increase site performance without making ANY modifications to your existing code base. if you require more fine-tuned control, you can assign caching best on regex routes using http-cache's API (which can be used as a CommonJS module, or as a JSON-RPC web-service)

Installing npm (node package manager)

  curl http://npmjs.org/install.sh | sh

Installing node-http-cache

  npm install http-cache

How to setup a basic caching server

  var http = require('http'),
      httpCache = require('http-cache');

  // this will start a new front-facing httpServer on port 8000
  httpCache.createServer(9000, 'localhost').listen(8000);

  // the target httpServer (which we will cache) is listening on port 9000
  http.createServer(function (req, res){
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.write('request successfully cached!' + '\n' + JSON.stringify(req.headers, true, 2));
    res.end();
  }).listen(9000);

How to cache requests in an existing node.js application

How to setup a customized caching server using regex routes

coming soon...

How to talk to http-cache over JSON-RPC

coming soon...

See the demo for further examples.

Why doesn't node-http-cache have more advanced features like x, y, or z?

if you have a suggestion for a feature currently not supported, feel free to open a support issue. node-http-cache is designed to just cache http requests


### License

(The MIT License)

Copyright (c) 2010 Marak Squires

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.

node-http-cache's People

Contributors

marak avatar

Watchers

 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.