http-errors

Create HTTP errors for Express, Koa, Connect, etc. with ease.轻松地创建Express、Koa、Connect等的HTTP错误。

Install

This is a Node.js module available through the npm registry. 这是一个Node.js模块，可通过npm注册表获得。Installation is done using the npm install command:使用npm install命令完成安装：

$ npm install http-errors

Example实例

var createError = require('http-errors')
var express = require('express')
var app = express()

app.use(function (req, res, next) {
  if (!req.user) return next(createError(401, 'Please login to view this page.'))
  next()
})

API

This is the current API, currently extracted from Koa and subject to change.这是当前的API，目前从KOA中提取，并有变化。

Error Properties错误属性

• expose - can be used to signal if message should be sent to the client, defaulting to false when status >= 500可用于指示是否应向客户端发送消息，当status>=500时，默认值为false
• headers - can be an object of header names to values to be sent to the client, defaulting to undefined. 可以是要发送到客户端的值的标题名对象，默认为undefined。When defined, the key names should all be lower-cased定义时，键名称应全部小写
• message - the traditional error message, which should be kept short and all single line传统的错误信息，应该保持简短且全部为单行
• status - the status code of the error, mirroring statusCode for general compatibility错误的状态代码，镜像statusCode代码以实现一般兼容性
• statusCode - the status code of the error, defaulting to 500错误的状态代码，默认为500

createError([status], [message], [properties])

Create a new error object with the given message msg. 使用给定的消息msg创建一个新的错误对象。The error object inherits from createError.HttpError.错误对象继承自createError.HttpError。

var err = createError(404, 'This video does not exist!')

• status: 500 - the status code as a number状态代码是一个数字
• message - the message of the error, defaulting to node's text for that status code.错误消息，默认为该状态代码的节点文本。
• properties - custom properties to attach to the object要附加到对象的自定义特性

createError([status], [error], [properties])

Extend the given error object with createError.HttpError properties. 使用createError.HttpError属性扩展给定的error对象。This will not alter the inheritance of the given error object, and the modified error object is the return value.这不会改变给定错误对象的继承，修改后的error对象是返回值。

fs.readFile('foo.txt', function (err, buf) {
  if (err) {
    if (err.code === 'ENOENT') {
      var httpError = createError(404, err, { expose: false })
    } else {
      var httpError = createError(500, err)
    }
  }
})

• status - the status code as a number状态代码是一个数字
• error - the error object to extend要扩展的错误对象
• properties - custom properties to attach to the object要附加到对象的自定义特性

createError.isHttpError(val)

Determine if the provided val is an HttpError. 确定提供的val是否为HttpError。This will return true if the error inherits from the HttpError constructor of this module or matches the "duck type" for an error this module creates. 如果error继承自此模块的HttpError构造函数，或者与此模块创建的错误的“duck type”匹配，则返回true。All outputs from the createError factory will return true for this function, including if an non-HttpError was passed into the factory.对于此函数，createError工厂的所有输出将返回true，包括是否将非HttpError传递到工厂。

new createError[code || name]([msg]))

Create a new error object with the given message msg. 使用给定的消息msg创建一个新的错误对象。The error object inherits from createError.HttpError.错误对象继承自createError.HttpError。

var err = new createError.NotFound()

• code - the status code as a number状态代码是一个数字
• name - the name of the error as a "bumpy case", i.e. NotFound or InternalServerError.错误名称为“颠簸案例”，即NotFound或InternalServerError。

List of all constructors所有构造函数清单

License

MIT