Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 1.33 KB

README.textile

File metadata and controls

46 lines (35 loc) · 1.33 KB

Memcache.js

This is an implementation of the memcache protocol written in javascript. It uses the sockets layer as provided by the
node.js “net” module.

The simplest way to install this code is by using npm:


npm install memcachejs

A simple var Memcache = require('memcachejs') will then be enough to get you started.

Simple usage example:


var Memcache = require('memcachejs');
// Host and port of the constructor are optional. Default values are "localhost" and 11211. 
var connection = new Memcache(host, port);

// setting key "some_key" to the value "some_value" on the memcache server
connection.set('some_key', 'some_value');
// same with callback and additional options
connection.set('some_key', 'some_value', {
	expires:60,
	flags:0,
	callback: function () {
		// do something here
	}
});

// retrieve key "some_key" from the memcache server
connection.get('some_key', function(response) {
	if (response.success) {
		// process results, they are stored in response.data
		console.dir(response.data);
	}
});
bc. 

After you are finished getting / setting data from your server, you should tell all connections to close by issuing the @shutdown()@ command:

connection.shutdown();

This client uses connection pooling, as suggested by the memcached documentation. If you’d like to turn it off, set
Memcache.pooling to false.