@@ -1,7 +1,7 @@
# send
-[![NPM Version][npm-image]][npm-url]
-[![NPM Downloads][downloads-image]][downloads-url]
+[![NPM Version][npm-version-image]][npm-url]
+[![NPM Downloads][npm-downloads-image]][npm-url]
[![Linux Build][travis-image]][travis-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]
@@ -174,7 +174,27 @@
## Examples
-### Small example
+### Serve a specific file
+
+This simple example will send a specific file to all requests.
+
+```js
+var http = require('http')
+var send = require('send')
+
+var server = http.createServer(function onRequest (req, res) {
+ send(req, '/path/to/index.html')
+ .pipe(res)
+})
+
+server.listen(3000)
+```
+
+### Serve all files from a directory
+
+This simple example will just serve up all the files in a
+given directory as the top-level. For example, a request
+`GET /foo.txt` will send back `/www/public/foo.txt`.
```js
var http = require('http')
@@ -182,7 +202,8 @@
var send = require('send')
var server = http.createServer(function onRequest (req, res) {
- send(req, parseUrl(req).pathname).pipe(res)
+ send(req, parseUrl(req).pathname, { root: '/www/public' })
+ .pipe(res)
})
server.listen(3000)
@@ -204,7 +225,8 @@
})
var server = http.createServer(function onRequest (req, res) {
- send(req, parseUrl(req).pathname).pipe(res)
+ send(req, parseUrl(req).pathname, { root: '/www/public' })
+ .pipe(res)
})
server.listen(3000)
@@ -224,7 +246,7 @@
// Transfer arbitrary files from within /www/example.com/public/*
// with a custom handler for directory listing
var server = http.createServer(function onRequest (req, res) {
- send(req, parseUrl(req).pathname, {index: false, root: '/www/example.com/public'})
+ send(req, parseUrl(req).pathname, { index: false, root: '/www/public' })
.once('directory', directory)
.pipe(res)
})
@@ -280,7 +302,7 @@
// transfer arbitrary files from within
// /www/example.com/public/*
- send(req, parseUrl(req).pathname, {root: '/www/example.com/public'})
+ send(req, parseUrl(req).pathname, { root: '/www/public' })
.on('error', error)
.on('directory', redirect)
.on('headers', headers)
@@ -294,13 +316,14 @@
[MIT](LICENSE)
-[npm-image]: https://img.shields.io/npm/v/send.svg
-[npm-url]: https://npmjs.org/package/send
-[travis-image]: https://img.shields.io/travis/pillarjs/send/master.svg?label=linux
-[travis-url]: https://travis-ci.org/pillarjs/send
-[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/send/master.svg?label=windows
+[appveyor-image]: https://badgen.net/appveyor/ci/dougwilson/send/master?label=windows
[appveyor-url]: https://ci.appveyor.com/project/dougwilson/send
-[coveralls-image]: https://img.shields.io/coveralls/pillarjs/send/master.svg
+[coveralls-image]: https://badgen.net/coveralls/c/github/pillarjs/send/master
[coveralls-url]: https://coveralls.io/r/pillarjs/send?branch=master
-[downloads-image]: https://img.shields.io/npm/dm/send.svg
-[downloads-url]: https://npmjs.org/package/send
+[node-image]: https://badgen.net/npm/node/send
+[node-url]: https://nodejs.org/en/download/
+[npm-downloads-image]: https://badgen.net/npm/dm/send
+[npm-url]: https://npmjs.org/package/send
+[npm-version-image]: https://badgen.net/npm/v/send
+[travis-image]: https://badgen.net/travis/pillarjs/send/master?label=linux
+[travis-url]: https://travis-ci.org/pillarjs/send