update
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# ignore-by-default
|
||||
|
||||
This is a package aimed at Node.js development tools. It provides a list of
|
||||
directories that should probably be ignored by such tools, e.g. when watching
|
||||
for file changes.
|
||||
|
||||
It's used by [AVA](https://www.npmjs.com/package/ava) and
|
||||
[nodemon](https://www.npmjs.com/package/nodemon).
|
||||
|
||||
[Please contribute!](./CONTRIBUTING.md)
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
npm install --save ignore-by-default
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The `ignore-by-default` module exports a `directories()` function, which will
|
||||
return an array of directory names. These are the ones you should ignore.
|
||||
|
||||
```js
|
||||
// ['.git', '.sass_cache', …]
|
||||
var ignoredDirectories = require('ignore-by-default').directories()
|
||||
```
|
||||
@@ -0,0 +1,208 @@
|
||||
/*!
|
||||
* serve-static
|
||||
* Copyright(c) 2010 Sencha Inc.
|
||||
* Copyright(c) 2011 TJ Holowaychuk
|
||||
* Copyright(c) 2014-2016 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var encodeUrl = require('encodeurl')
|
||||
var escapeHtml = require('escape-html')
|
||||
var parseUrl = require('parseurl')
|
||||
var resolve = require('path').resolve
|
||||
var send = require('send')
|
||||
var url = require('url')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @public
|
||||
*/
|
||||
|
||||
module.exports = serveStatic
|
||||
|
||||
/**
|
||||
* @param {string} root
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function serveStatic (root, options) {
|
||||
if (!root) {
|
||||
throw new TypeError('root path required')
|
||||
}
|
||||
|
||||
if (typeof root !== 'string') {
|
||||
throw new TypeError('root path must be a string')
|
||||
}
|
||||
|
||||
// copy options object
|
||||
var opts = Object.create(options || null)
|
||||
|
||||
// fall-though
|
||||
var fallthrough = opts.fallthrough !== false
|
||||
|
||||
// default redirect
|
||||
var redirect = opts.redirect !== false
|
||||
|
||||
// headers listener
|
||||
var setHeaders = opts.setHeaders
|
||||
|
||||
if (setHeaders && typeof setHeaders !== 'function') {
|
||||
throw new TypeError('option setHeaders must be function')
|
||||
}
|
||||
|
||||
// setup options for send
|
||||
opts.maxage = opts.maxage || opts.maxAge || 0
|
||||
opts.root = resolve(root)
|
||||
|
||||
// construct directory listener
|
||||
var onDirectory = redirect
|
||||
? createRedirectDirectoryListener()
|
||||
: createNotFoundDirectoryListener()
|
||||
|
||||
return function serveStatic (req, res, next) {
|
||||
if (req.method !== 'GET' && req.method !== 'HEAD') {
|
||||
if (fallthrough) {
|
||||
return next()
|
||||
}
|
||||
|
||||
// method not allowed
|
||||
res.statusCode = 405
|
||||
res.setHeader('Allow', 'GET, HEAD')
|
||||
res.setHeader('Content-Length', '0')
|
||||
res.end()
|
||||
return
|
||||
}
|
||||
|
||||
var forwardError = !fallthrough
|
||||
var originalUrl = parseUrl.original(req)
|
||||
var path = parseUrl(req).pathname
|
||||
|
||||
// make sure redirect occurs at mount
|
||||
if (path === '/' && originalUrl.pathname.substr(-1) !== '/') {
|
||||
path = ''
|
||||
}
|
||||
|
||||
// create send stream
|
||||
var stream = send(req, path, opts)
|
||||
|
||||
// add directory handler
|
||||
stream.on('directory', onDirectory)
|
||||
|
||||
// add headers listener
|
||||
if (setHeaders) {
|
||||
stream.on('headers', setHeaders)
|
||||
}
|
||||
|
||||
// add file listener for fallthrough
|
||||
if (fallthrough) {
|
||||
stream.on('file', function onFile () {
|
||||
// once file is determined, always forward error
|
||||
forwardError = true
|
||||
})
|
||||
}
|
||||
|
||||
// forward errors
|
||||
stream.on('error', function error (err) {
|
||||
if (forwardError || !(err.statusCode < 500)) {
|
||||
next(err)
|
||||
return
|
||||
}
|
||||
|
||||
next()
|
||||
})
|
||||
|
||||
// pipe
|
||||
stream.pipe(res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Collapse all leading slashes into a single slash
|
||||
* @private
|
||||
*/
|
||||
function collapseLeadingSlashes (str) {
|
||||
for (var i = 0; i < str.length; i++) {
|
||||
if (str.charCodeAt(i) !== 0x2f /* / */) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return i > 1
|
||||
? '/' + str.substr(i)
|
||||
: str
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a minimal HTML document.
|
||||
*
|
||||
* @param {string} title
|
||||
* @param {string} body
|
||||
* @private
|
||||
*/
|
||||
|
||||
function createHtmlDocument (title, body) {
|
||||
return '<!DOCTYPE html>\n' +
|
||||
'<html lang="en">\n' +
|
||||
'<head>\n' +
|
||||
'<meta charset="utf-8">\n' +
|
||||
'<title>' + title + '</title>\n' +
|
||||
'</head>\n' +
|
||||
'<body>\n' +
|
||||
'<pre>' + body + '</pre>\n' +
|
||||
'</body>\n' +
|
||||
'</html>\n'
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a directory listener that just 404s.
|
||||
* @private
|
||||
*/
|
||||
|
||||
function createNotFoundDirectoryListener () {
|
||||
return function notFound () {
|
||||
this.error(404)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a directory listener that performs a redirect.
|
||||
* @private
|
||||
*/
|
||||
|
||||
function createRedirectDirectoryListener () {
|
||||
return function redirect (res) {
|
||||
if (this.hasTrailingSlash()) {
|
||||
this.error(404)
|
||||
return
|
||||
}
|
||||
|
||||
// get original URL
|
||||
var originalUrl = parseUrl.original(this.req)
|
||||
|
||||
// append trailing slash
|
||||
originalUrl.path = null
|
||||
originalUrl.pathname = collapseLeadingSlashes(originalUrl.pathname + '/')
|
||||
|
||||
// reformat the URL
|
||||
var loc = encodeUrl(url.format(originalUrl))
|
||||
var doc = createHtmlDocument('Redirecting', 'Redirecting to ' + escapeHtml(loc))
|
||||
|
||||
// send redirect response
|
||||
res.statusCode = 301
|
||||
res.setHeader('Content-Type', 'text/html; charset=UTF-8')
|
||||
res.setHeader('Content-Length', Buffer.byteLength(doc))
|
||||
res.setHeader('Content-Security-Policy', "default-src 'none'")
|
||||
res.setHeader('X-Content-Type-Options', 'nosniff')
|
||||
res.setHeader('Location', loc)
|
||||
res.end(doc)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,223 @@
|
||||
# raw-body
|
||||
|
||||
[![NPM Version][npm-image]][npm-url]
|
||||
[![NPM Downloads][downloads-image]][downloads-url]
|
||||
[![Node.js Version][node-version-image]][node-version-url]
|
||||
[![Build status][github-actions-ci-image]][github-actions-ci-url]
|
||||
[![Test coverage][coveralls-image]][coveralls-url]
|
||||
|
||||
Gets the entire buffer of a stream either as a `Buffer` or a string.
|
||||
Validates the stream's length against an expected length and maximum limit.
|
||||
Ideal for parsing request bodies.
|
||||
|
||||
## Install
|
||||
|
||||
This is a [Node.js](https://nodejs.org/en/) module available through the
|
||||
[npm registry](https://www.npmjs.com/). Installation is done using the
|
||||
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
||||
|
||||
```sh
|
||||
$ npm install raw-body
|
||||
```
|
||||
|
||||
### TypeScript
|
||||
|
||||
This module includes a [TypeScript](https://www.typescriptlang.org/)
|
||||
declaration file to enable auto complete in compatible editors and type
|
||||
information for TypeScript projects. This module depends on the Node.js
|
||||
types, so install `@types/node`:
|
||||
|
||||
```sh
|
||||
$ npm install @types/node
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```js
|
||||
var getRawBody = require('raw-body')
|
||||
```
|
||||
|
||||
### getRawBody(stream, [options], [callback])
|
||||
|
||||
**Returns a promise if no callback specified and global `Promise` exists.**
|
||||
|
||||
Options:
|
||||
|
||||
- `length` - The length of the stream.
|
||||
If the contents of the stream do not add up to this length,
|
||||
an `400` error code is returned.
|
||||
- `limit` - The byte limit of the body.
|
||||
This is the number of bytes or any string format supported by
|
||||
[bytes](https://www.npmjs.com/package/bytes),
|
||||
for example `1000`, `'500kb'` or `'3mb'`.
|
||||
If the body ends up being larger than this limit,
|
||||
a `413` error code is returned.
|
||||
- `encoding` - The encoding to use to decode the body into a string.
|
||||
By default, a `Buffer` instance will be returned when no encoding is specified.
|
||||
Most likely, you want `utf-8`, so setting `encoding` to `true` will decode as `utf-8`.
|
||||
You can use any type of encoding supported by [iconv-lite](https://www.npmjs.org/package/iconv-lite#readme).
|
||||
|
||||
You can also pass a string in place of options to just specify the encoding.
|
||||
|
||||
If an error occurs, the stream will be paused, everything unpiped,
|
||||
and you are responsible for correctly disposing the stream.
|
||||
For HTTP requests, you may need to finish consuming the stream if
|
||||
you want to keep the socket open for future requests. For streams
|
||||
that use file descriptors, you should `stream.destroy()` or
|
||||
`stream.close()` to prevent leaks.
|
||||
|
||||
## Errors
|
||||
|
||||
This module creates errors depending on the error condition during reading.
|
||||
The error may be an error from the underlying Node.js implementation, but is
|
||||
otherwise an error created by this module, which has the following attributes:
|
||||
|
||||
* `limit` - the limit in bytes
|
||||
* `length` and `expected` - the expected length of the stream
|
||||
* `received` - the received bytes
|
||||
* `encoding` - the invalid encoding
|
||||
* `status` and `statusCode` - the corresponding status code for the error
|
||||
* `type` - the error type
|
||||
|
||||
### Types
|
||||
|
||||
The errors from this module have a `type` property which allows for the programmatic
|
||||
determination of the type of error returned.
|
||||
|
||||
#### encoding.unsupported
|
||||
|
||||
This error will occur when the `encoding` option is specified, but the value does
|
||||
not map to an encoding supported by the [iconv-lite](https://www.npmjs.org/package/iconv-lite#readme)
|
||||
module.
|
||||
|
||||
#### entity.too.large
|
||||
|
||||
This error will occur when the `limit` option is specified, but the stream has
|
||||
an entity that is larger.
|
||||
|
||||
#### request.aborted
|
||||
|
||||
This error will occur when the request stream is aborted by the client before
|
||||
reading the body has finished.
|
||||
|
||||
#### request.size.invalid
|
||||
|
||||
This error will occur when the `length` option is specified, but the stream has
|
||||
emitted more bytes.
|
||||
|
||||
#### stream.encoding.set
|
||||
|
||||
This error will occur when the given stream has an encoding set on it, making it
|
||||
a decoded stream. The stream should not have an encoding set and is expected to
|
||||
emit `Buffer` objects.
|
||||
|
||||
#### stream.not.readable
|
||||
|
||||
This error will occur when the given stream is not readable.
|
||||
|
||||
## Examples
|
||||
|
||||
### Simple Express example
|
||||
|
||||
```js
|
||||
var contentType = require('content-type')
|
||||
var express = require('express')
|
||||
var getRawBody = require('raw-body')
|
||||
|
||||
var app = express()
|
||||
|
||||
app.use(function (req, res, next) {
|
||||
getRawBody(req, {
|
||||
length: req.headers['content-length'],
|
||||
limit: '1mb',
|
||||
encoding: contentType.parse(req).parameters.charset
|
||||
}, function (err, string) {
|
||||
if (err) return next(err)
|
||||
req.text = string
|
||||
next()
|
||||
})
|
||||
})
|
||||
|
||||
// now access req.text
|
||||
```
|
||||
|
||||
### Simple Koa example
|
||||
|
||||
```js
|
||||
var contentType = require('content-type')
|
||||
var getRawBody = require('raw-body')
|
||||
var koa = require('koa')
|
||||
|
||||
var app = koa()
|
||||
|
||||
app.use(function * (next) {
|
||||
this.text = yield getRawBody(this.req, {
|
||||
length: this.req.headers['content-length'],
|
||||
limit: '1mb',
|
||||
encoding: contentType.parse(this.req).parameters.charset
|
||||
})
|
||||
yield next
|
||||
})
|
||||
|
||||
// now access this.text
|
||||
```
|
||||
|
||||
### Using as a promise
|
||||
|
||||
To use this library as a promise, simply omit the `callback` and a promise is
|
||||
returned, provided that a global `Promise` is defined.
|
||||
|
||||
```js
|
||||
var getRawBody = require('raw-body')
|
||||
var http = require('http')
|
||||
|
||||
var server = http.createServer(function (req, res) {
|
||||
getRawBody(req)
|
||||
.then(function (buf) {
|
||||
res.statusCode = 200
|
||||
res.end(buf.length + ' bytes submitted')
|
||||
})
|
||||
.catch(function (err) {
|
||||
res.statusCode = 500
|
||||
res.end(err.message)
|
||||
})
|
||||
})
|
||||
|
||||
server.listen(3000)
|
||||
```
|
||||
|
||||
### Using with TypeScript
|
||||
|
||||
```ts
|
||||
import * as getRawBody from 'raw-body';
|
||||
import * as http from 'http';
|
||||
|
||||
const server = http.createServer((req, res) => {
|
||||
getRawBody(req)
|
||||
.then((buf) => {
|
||||
res.statusCode = 200;
|
||||
res.end(buf.length + ' bytes submitted');
|
||||
})
|
||||
.catch((err) => {
|
||||
res.statusCode = err.statusCode;
|
||||
res.end(err.message);
|
||||
});
|
||||
});
|
||||
|
||||
server.listen(3000);
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/raw-body.svg
|
||||
[npm-url]: https://npmjs.org/package/raw-body
|
||||
[node-version-image]: https://img.shields.io/node/v/raw-body.svg
|
||||
[node-version-url]: https://nodejs.org/en/download/
|
||||
[coveralls-image]: https://img.shields.io/coveralls/stream-utils/raw-body/master.svg
|
||||
[coveralls-url]: https://coveralls.io/r/stream-utils/raw-body?branch=master
|
||||
[downloads-image]: https://img.shields.io/npm/dm/raw-body.svg
|
||||
[downloads-url]: https://npmjs.org/package/raw-body
|
||||
[github-actions-ci-image]: https://img.shields.io/github/actions/workflow/status/stream-utils/raw-body/ci.yml?branch=master&label=ci
|
||||
[github-actions-ci-url]: https://github.com/jshttp/stream-utils/raw-body?query=workflow%3Aci
|
||||
Reference in New Issue
Block a user