Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

send

Package Overview
Dependencies
4
Maintainers
1
Versions
61
Issues
File Explorer

Advanced tools

send

Better streaming static file server with Range and conditional-GET support

    0.1.0

Version published
Maintainers
1
Weekly downloads
26,221,281
decreased by-0.22%

Weekly downloads

Readme

Source

send

Send is Connect's static() extracted for generalized use, a streaming static file server supporting partial responses (Ranges), conditional-GET negotiation, high test coverage, and granular events which may be leveraged to take appropriate actions in your application or framework.

Installation

$ npm install send

Examples

Small:

var http = require('http'); var send = require('send'); var app = http.createServer(function(req, res){ send(req, req.url).pipe(res); });

Serving from a root directory with custom error-handling:

var http = require('http'); var send = require('send'); var app = http.createServer(function(req, res){ // your custom error-handling logic: function error(err) { res.statusCode = err.status || 500; res.end(err.message); } // your custom directory handling logic: function redirect() { res.statusCode = 301; res.setHeader('Location', req.url + '/'); res.end('Redirecting to ' + req.url + '/'); } // transfer arbitrary files from within // /www/example.com/public/* send(req, url.parse(req.url).pathname) .root('/www/example.com/public') .on('error', error) .on('directory', redirect) .pipe(res); });

API

Events

  • error an error occurred (err)
  • directory a directory was requested
  • stream file streaming has started (stream)
  • end streaming has completed

.root(dir)

Serve files relative to path. Aliased as .from(dir).

.index(path)

By default send supports "index.html" files, to disable this invoke .index(false) or to supply a new index pass a string.

.maxage(ms)

Provide a max-age in milliseconds for http caching, defaults to 0.

Error-handling

By default when no error listeners are present an automatic response will be made, otherwise you have full control over the response, aka you may show a 5xx page etc.

Caching

It does not perform internal caching, you should use a reverse proxy cache such as Varnish for this, or those fancy things called CDNs. If your application is small enough that it would benefit from single-node memory caching, it's small enough that it does not need caching at all ;).

Debugging

To enable debug() instrumentation output export DEBUG:

$ DEBUG=send node app

Running tests

$ npm install $ make test

License

(The MIT License)

Copyright (c) 2012 TJ Holowaychuk <[email protected]>

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.

Keywords

FAQs

What is send?

Better streaming static file server with Range and conditional-GET support

Is send popular?

The npm package send receives a total of 21,803,012 weekly downloads. As such, send popularity was classified as popular.

Is send well maintained?

We found that send demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 19 Sep 2012
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc