senchalabs /connect

Connect is an extensible HTTP server framework for node using "plugins" known as middleware.

★ 9,866⑂ 1,075👁 294⑃ 435● 712▤ 0
JavaScriptMITCreated 2010-05-26
+0
Daily
9,866
stars
1,075
forks
294
watchers
435
prs
712
issues
0
releases

README

[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![Build Status][github-actions-ci-image]][github-actions-ci-url]
[![Test Coverage][coveralls-image]][coveralls-url]



  Connect is an extensible HTTP server framework for node using "plugins" known as _middleware_.

js
var connect = require('connect');
var http = require('http');

var app = connect();

// gzip/deflate outgoing responses
var compression = require('compression');
app.use(compression());

// store session state in browser cookie
var cookieSession = require('cookie-session');
app.use(cookieSession({
    keys: ['secret1', 'secret2']
}));

// parse urlencoded request bodies into req.body
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({extended: false}));

// respond to all requests
app.use(function(req, res){
  res.end('Hello from Connect!\n');
});

//create node.js http server and listen on port
http.createServer(app).listen(3000);


 Getting Started

Connect is a simple framework to glue together various "middleware" to handle requests.

 Install Connect

sh
$ npm install connect


 Create an app

The main component is a Connect "app". This will store all the middleware
added and is, itself, a function.

js
var app = connect();


 Use middleware

The core of Connect is "using" middleware. Middleware are added as a "stack"
where incoming requests will execute each middleware one-by-one until a middleware
does not call next() within it.

js
app.use(function middleware1(req, res, next) {
  // middleware 1
  next();
});
app.use(function middleware2(req, res, next) {
  // middleware 2
  next();
});


 Mount middleware

The .use() method also takes an optional path string that is matched against
the beginning of the incoming request URL. This allows for basic routing.

js
app.use('/foo', function fooMiddleware(req, res, next) {
  // req.url starts with "/foo"
  next();
});
app.use('/bar', function barMiddleware(req, res, next) {
  // req.url starts with "/bar"
  next();
});


 Error middleware

There are special cases of "error-handling" middleware. There are middleware
where the function takes exactly 4 arguments. When a middleware passes an error
to next, the app will proceed to look for the error middleware that was declared
after that middleware and invoke it, skipping any error middleware above that
middleware and any non-error middleware below.

js
// regular middleware
app.use(function (req, res, next) {
  // i had an error
  next(new Error('boom!'));
});

// error middleware for errors that occurred in middleware
// declared before this
app.use(function onerror(err, req, res, next) {
  // an error occurred!
});


 Create a server from the app

The last step is to actually use the Connect app in a server. The .listen() method
is a convenience to start a HTTP server (and is identical to the http.Server's listen
method in the version of Node.js you are running).

js
var server = app.listen(port);


The app itself is 

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON