박민정

[feat] 회원가입

Showing 173 changed files with 4861 additions and 0 deletions
...@@ -4,8 +4,21 @@ const express = require('express') ...@@ -4,8 +4,21 @@ const express = require('express')
4 const app = express() 4 const app = express()
5 const port = 5000 5 const port = 5000
6 6
7 +<<<<<<< HEAD
8 +// User.js 정보 가져옴 (회원가입 위해)
9 +const { User } = require("./models/User")
10 +
11 +// body-parsor 가져옴 (clinet에서 오는 정보를 서버에서 분석해서 가져올 수 있음)
12 +const bodyParser = require('body-parser')
13 +app.use(bodyParser.urlencoded({extended: true})) // application/x-www-form-urlencoded 로 되어있는 데이터를 분석해서 가져올 수 있음
14 +app.use(bodyParser.json()) // application/json 으로 되어있는 데이터를 분석해서 가져올 수 있음
15 +
16 +const mongoose = require('mongoose')
17 +mongoose.connect('mongodb+srv://mindyeoi:aaa111@boilerplate.djq4a.mongodb.net/myFirstDatabase?retryWrites=true&w=majority',
18 +=======
7 const mongoose = require('mongoose') 19 const mongoose = require('mongoose')
8 mongoose.connect('mongodb+srv://mindyeoi:20241004qw@boilerplate.djq4a.mongodb.net/myFirstDatabase?retryWrites=true&w=majority', 20 mongoose.connect('mongodb+srv://mindyeoi:20241004qw@boilerplate.djq4a.mongodb.net/myFirstDatabase?retryWrites=true&w=majority',
21 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
9 { 22 {
10 useNewUrlParser: true, useUnifiedTopology: true, useCreateIndex: true, useFindAndModify: false 23 useNewUrlParser: true, useUnifiedTopology: true, useCreateIndex: true, useFindAndModify: false
11 }).then(() => console.log('MongoDB connected...')) 24 }).then(() => console.log('MongoDB connected...'))
...@@ -13,6 +26,27 @@ mongoose.connect('mongodb+srv://mindyeoi:20241004qw@boilerplate.djq4a.mongodb.ne ...@@ -13,6 +26,27 @@ mongoose.connect('mongodb+srv://mindyeoi:20241004qw@boilerplate.djq4a.mongodb.ne
13 26
14 app.get('/', (req, res) => res.send('Hello World!')) 27 app.get('/', (req, res) => res.send('Hello World!'))
15 28
29 +<<<<<<< HEAD
30 +// 회원가입 기능
31 +// post 메소드를 이용, end point는 register
32 +app.post('/register', (req, res) => {
33 + // 회원가입할 때 필요한 정보들(User.js에 있는 것들)을 client에서 가져오면
34 + // 그것들을 데이터베이스에 넣어준다.
35 +
36 + const user = new User(req.body) // bodyparser가 있기 때문에 여기 User의 정보를 들어가게 할 수 있음
37 + user.save((err, userInfo) => {// 정보들이 user모델에 저장
38 + // 에러가 생기면
39 + if(err) return res.json({success:false, err}) //클라이언트에 에러가 있다고 json 형식으로 전달
40 + // 성공하면
41 + return res.status(200).json({
42 + success: true // json형식으로 success: true 전달
43 + })
44 + })
45 +
46 +})
47 +
48 +=======
49 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
16 app.listen(port, () => 50 app.listen(port, () =>
17 console.log(`Example app listening at http://localhost:${port}`) 51 console.log(`Example app listening at http://localhost:${port}`)
18 ) 52 )
......
1 +// monggoDB Model and Schema
2 +const mongoose = require('mongoose');
3 +
4 +
5 +const userSchema = mongoose.Schema({
6 + name:{
7 + type: String,
8 + maxlength: 50
9 + },
10 + email:{
11 + type: String,
12 + trim: true, // 'minjeong park'처럼 space가 있는 문자에 space가 없어지도록 함
13 + unique: 1 // 똑같은 이메일은 쓸 수 없도록
14 + },
15 + password: {
16 + type: String,
17 + minlength: 5
18 + },
19 + lastname: {
20 + type: String,
21 + maxlength: 50
22 + },
23 + role: { // Number==1 이면 관리자, number==0 이면 일반 유저
24 + type: Number,
25 + default: 0 // default는 0
26 + },
27 + token : {
28 + type : String
29 + },
30 + tokenExp: { //토큰의 유효기간
31 + type: Number
32 + }
33 +})
34 +
35 +// 만든 스키마를 모델로 감싸줌
36 +const User = mongoose.model('User', userSchema)
37 +
38 +// 이 모델을 다른 파일에서도 쓰고싶으면 아래와 같이 해주면 됨
39 +module.exports = {User}
...\ No newline at end of file ...\ No newline at end of file
1 { 1 {
2 +<<<<<<< HEAD
3 + "_from": "body-parser",
4 +=======
2 "_from": "body-parser@1.19.0", 5 "_from": "body-parser@1.19.0",
6 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
3 "_id": "body-parser@1.19.0", 7 "_id": "body-parser@1.19.0",
4 "_inBundle": false, 8 "_inBundle": false,
5 "_integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==", 9 "_integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==",
6 "_location": "/body-parser", 10 "_location": "/body-parser",
7 "_phantomChildren": {}, 11 "_phantomChildren": {},
8 "_requested": { 12 "_requested": {
13 +<<<<<<< HEAD
14 + "type": "tag",
15 + "registry": true,
16 + "raw": "body-parser",
17 + "name": "body-parser",
18 + "escapedName": "body-parser",
19 + "rawSpec": "",
20 + "saveSpec": null,
21 + "fetchSpec": "latest"
22 + },
23 + "_requiredBy": [
24 + "#USER",
25 + "/",
26 +=======
9 "type": "version", 27 "type": "version",
10 "registry": true, 28 "registry": true,
11 "raw": "body-parser@1.19.0", 29 "raw": "body-parser@1.19.0",
...@@ -16,12 +34,18 @@ ...@@ -16,12 +34,18 @@
16 "fetchSpec": "1.19.0" 34 "fetchSpec": "1.19.0"
17 }, 35 },
18 "_requiredBy": [ 36 "_requiredBy": [
37 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
19 "/express" 38 "/express"
20 ], 39 ],
21 "_resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz", 40 "_resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz",
22 "_shasum": "96b2709e57c9c4e09a6fd66a8fd979844f69f08a", 41 "_shasum": "96b2709e57c9c4e09a6fd66a8fd979844f69f08a",
42 +<<<<<<< HEAD
43 + "_spec": "body-parser",
44 + "_where": "/Users/mindyeoi/Desktop/We-Shop/boiler-plate",
45 +=======
23 "_spec": "body-parser@1.19.0", 46 "_spec": "body-parser@1.19.0",
24 "_where": "/Users/mindyeoi/Desktop/We-Shop/boiler-plate/node_modules/express", 47 "_where": "/Users/mindyeoi/Desktop/We-Shop/boiler-plate/node_modules/express",
48 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
25 "bugs": { 49 "bugs": {
26 "url": "https://github.com/expressjs/body-parser/issues" 50 "url": "https://github.com/expressjs/body-parser/issues"
27 }, 51 },
......
...@@ -7,9 +7,16 @@ ...@@ -7,9 +7,16 @@
7 "start": "node index.js", 7 "start": "node index.js",
8 "test": "echo \"Error: no test specified\" && exit 1" 8 "test": "echo \"Error: no test specified\" && exit 1"
9 }, 9 },
10 +<<<<<<< HEAD
11 + "author": "minjeong Park",
12 + "license": "ISC",
13 + "dependencies": {
14 + "body-parser": "^1.19.0",
15 +=======
10 "author": "mindyeoi", 16 "author": "mindyeoi",
11 "license": "ISC", 17 "license": "ISC",
12 "dependencies": { 18 "dependencies": {
19 +>>>>>>> 8d4c706f8fbe0f97a457ec2881c56d7c0d2862b9
13 "express": "^4.17.1", 20 "express": "^4.17.1",
14 "mongoose": "^5.12.11" 21 "mongoose": "^5.12.11"
15 } 22 }
......
This diff is collapsed. Click to expand it.
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
4 +Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This diff is collapsed. Click to expand it.
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + * @private
12 + */
13 +
14 +var deprecate = require('depd')('body-parser')
15 +
16 +/**
17 + * Cache of loaded parsers.
18 + * @private
19 + */
20 +
21 +var parsers = Object.create(null)
22 +
23 +/**
24 + * @typedef Parsers
25 + * @type {function}
26 + * @property {function} json
27 + * @property {function} raw
28 + * @property {function} text
29 + * @property {function} urlencoded
30 + */
31 +
32 +/**
33 + * Module exports.
34 + * @type {Parsers}
35 + */
36 +
37 +exports = module.exports = deprecate.function(bodyParser,
38 + 'bodyParser: use individual json/urlencoded middlewares')
39 +
40 +/**
41 + * JSON parser.
42 + * @public
43 + */
44 +
45 +Object.defineProperty(exports, 'json', {
46 + configurable: true,
47 + enumerable: true,
48 + get: createParserGetter('json')
49 +})
50 +
51 +/**
52 + * Raw parser.
53 + * @public
54 + */
55 +
56 +Object.defineProperty(exports, 'raw', {
57 + configurable: true,
58 + enumerable: true,
59 + get: createParserGetter('raw')
60 +})
61 +
62 +/**
63 + * Text parser.
64 + * @public
65 + */
66 +
67 +Object.defineProperty(exports, 'text', {
68 + configurable: true,
69 + enumerable: true,
70 + get: createParserGetter('text')
71 +})
72 +
73 +/**
74 + * URL-encoded parser.
75 + * @public
76 + */
77 +
78 +Object.defineProperty(exports, 'urlencoded', {
79 + configurable: true,
80 + enumerable: true,
81 + get: createParserGetter('urlencoded')
82 +})
83 +
84 +/**
85 + * Create a middleware to parse json and urlencoded bodies.
86 + *
87 + * @param {object} [options]
88 + * @return {function}
89 + * @deprecated
90 + * @public
91 + */
92 +
93 +function bodyParser (options) {
94 + var opts = {}
95 +
96 + // exclude type option
97 + if (options) {
98 + for (var prop in options) {
99 + if (prop !== 'type') {
100 + opts[prop] = options[prop]
101 + }
102 + }
103 + }
104 +
105 + var _urlencoded = exports.urlencoded(opts)
106 + var _json = exports.json(opts)
107 +
108 + return function bodyParser (req, res, next) {
109 + _json(req, res, function (err) {
110 + if (err) return next(err)
111 + _urlencoded(req, res, next)
112 + })
113 + }
114 +}
115 +
116 +/**
117 + * Create a getter for loading a parser.
118 + * @private
119 + */
120 +
121 +function createParserGetter (name) {
122 + return function get () {
123 + return loadParser(name)
124 + }
125 +}
126 +
127 +/**
128 + * Load a parser module.
129 + * @private
130 + */
131 +
132 +function loadParser (parserName) {
133 + var parser = parsers[parserName]
134 +
135 + if (parser !== undefined) {
136 + return parser
137 + }
138 +
139 + // this uses a switch for static require analysis
140 + switch (parserName) {
141 + case 'json':
142 + parser = require('./lib/types/json')
143 + break
144 + case 'raw':
145 + parser = require('./lib/types/raw')
146 + break
147 + case 'text':
148 + parser = require('./lib/types/text')
149 + break
150 + case 'urlencoded':
151 + parser = require('./lib/types/urlencoded')
152 + break
153 + }
154 +
155 + // store to prevent invoking require()
156 + return (parsers[parserName] = parser)
157 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + * @private
12 + */
13 +
14 +var createError = require('http-errors')
15 +var getBody = require('raw-body')
16 +var iconv = require('iconv-lite')
17 +var onFinished = require('on-finished')
18 +var zlib = require('zlib')
19 +
20 +/**
21 + * Module exports.
22 + */
23 +
24 +module.exports = read
25 +
26 +/**
27 + * Read a request into a buffer and parse.
28 + *
29 + * @param {object} req
30 + * @param {object} res
31 + * @param {function} next
32 + * @param {function} parse
33 + * @param {function} debug
34 + * @param {object} options
35 + * @private
36 + */
37 +
38 +function read (req, res, next, parse, debug, options) {
39 + var length
40 + var opts = options
41 + var stream
42 +
43 + // flag as parsed
44 + req._body = true
45 +
46 + // read options
47 + var encoding = opts.encoding !== null
48 + ? opts.encoding
49 + : null
50 + var verify = opts.verify
51 +
52 + try {
53 + // get the content stream
54 + stream = contentstream(req, debug, opts.inflate)
55 + length = stream.length
56 + stream.length = undefined
57 + } catch (err) {
58 + return next(err)
59 + }
60 +
61 + // set raw-body options
62 + opts.length = length
63 + opts.encoding = verify
64 + ? null
65 + : encoding
66 +
67 + // assert charset is supported
68 + if (opts.encoding === null && encoding !== null && !iconv.encodingExists(encoding)) {
69 + return next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
70 + charset: encoding.toLowerCase(),
71 + type: 'charset.unsupported'
72 + }))
73 + }
74 +
75 + // read body
76 + debug('read body')
77 + getBody(stream, opts, function (error, body) {
78 + if (error) {
79 + var _error
80 +
81 + if (error.type === 'encoding.unsupported') {
82 + // echo back charset
83 + _error = createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
84 + charset: encoding.toLowerCase(),
85 + type: 'charset.unsupported'
86 + })
87 + } else {
88 + // set status code on error
89 + _error = createError(400, error)
90 + }
91 +
92 + // read off entire request
93 + stream.resume()
94 + onFinished(req, function onfinished () {
95 + next(createError(400, _error))
96 + })
97 + return
98 + }
99 +
100 + // verify
101 + if (verify) {
102 + try {
103 + debug('verify body')
104 + verify(req, res, body, encoding)
105 + } catch (err) {
106 + next(createError(403, err, {
107 + body: body,
108 + type: err.type || 'entity.verify.failed'
109 + }))
110 + return
111 + }
112 + }
113 +
114 + // parse
115 + var str = body
116 + try {
117 + debug('parse body')
118 + str = typeof body !== 'string' && encoding !== null
119 + ? iconv.decode(body, encoding)
120 + : body
121 + req.body = parse(str)
122 + } catch (err) {
123 + next(createError(400, err, {
124 + body: str,
125 + type: err.type || 'entity.parse.failed'
126 + }))
127 + return
128 + }
129 +
130 + next()
131 + })
132 +}
133 +
134 +/**
135 + * Get the content stream of the request.
136 + *
137 + * @param {object} req
138 + * @param {function} debug
139 + * @param {boolean} [inflate=true]
140 + * @return {object}
141 + * @api private
142 + */
143 +
144 +function contentstream (req, debug, inflate) {
145 + var encoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
146 + var length = req.headers['content-length']
147 + var stream
148 +
149 + debug('content-encoding "%s"', encoding)
150 +
151 + if (inflate === false && encoding !== 'identity') {
152 + throw createError(415, 'content encoding unsupported', {
153 + encoding: encoding,
154 + type: 'encoding.unsupported'
155 + })
156 + }
157 +
158 + switch (encoding) {
159 + case 'deflate':
160 + stream = zlib.createInflate()
161 + debug('inflate body')
162 + req.pipe(stream)
163 + break
164 + case 'gzip':
165 + stream = zlib.createGunzip()
166 + debug('gunzip body')
167 + req.pipe(stream)
168 + break
169 + case 'identity':
170 + stream = req
171 + stream.length = length
172 + break
173 + default:
174 + throw createError(415, 'unsupported content encoding "' + encoding + '"', {
175 + encoding: encoding,
176 + type: 'encoding.unsupported'
177 + })
178 + }
179 +
180 + return stream
181 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var bytes = require('bytes')
16 +var contentType = require('content-type')
17 +var createError = require('http-errors')
18 +var debug = require('debug')('body-parser:json')
19 +var read = require('../read')
20 +var typeis = require('type-is')
21 +
22 +/**
23 + * Module exports.
24 + */
25 +
26 +module.exports = json
27 +
28 +/**
29 + * RegExp to match the first non-space in a string.
30 + *
31 + * Allowed whitespace is defined in RFC 7159:
32 + *
33 + * ws = *(
34 + * %x20 / ; Space
35 + * %x09 / ; Horizontal tab
36 + * %x0A / ; Line feed or New line
37 + * %x0D ) ; Carriage return
38 + */
39 +
40 +var FIRST_CHAR_REGEXP = /^[\x20\x09\x0a\x0d]*(.)/ // eslint-disable-line no-control-regex
41 +
42 +/**
43 + * Create a middleware to parse JSON bodies.
44 + *
45 + * @param {object} [options]
46 + * @return {function}
47 + * @public
48 + */
49 +
50 +function json (options) {
51 + var opts = options || {}
52 +
53 + var limit = typeof opts.limit !== 'number'
54 + ? bytes.parse(opts.limit || '100kb')
55 + : opts.limit
56 + var inflate = opts.inflate !== false
57 + var reviver = opts.reviver
58 + var strict = opts.strict !== false
59 + var type = opts.type || 'application/json'
60 + var verify = opts.verify || false
61 +
62 + if (verify !== false && typeof verify !== 'function') {
63 + throw new TypeError('option verify must be function')
64 + }
65 +
66 + // create the appropriate type checking function
67 + var shouldParse = typeof type !== 'function'
68 + ? typeChecker(type)
69 + : type
70 +
71 + function parse (body) {
72 + if (body.length === 0) {
73 + // special-case empty json body, as it's a common client-side mistake
74 + // TODO: maybe make this configurable or part of "strict" option
75 + return {}
76 + }
77 +
78 + if (strict) {
79 + var first = firstchar(body)
80 +
81 + if (first !== '{' && first !== '[') {
82 + debug('strict violation')
83 + throw createStrictSyntaxError(body, first)
84 + }
85 + }
86 +
87 + try {
88 + debug('parse json')
89 + return JSON.parse(body, reviver)
90 + } catch (e) {
91 + throw normalizeJsonSyntaxError(e, {
92 + message: e.message,
93 + stack: e.stack
94 + })
95 + }
96 + }
97 +
98 + return function jsonParser (req, res, next) {
99 + if (req._body) {
100 + debug('body already parsed')
101 + next()
102 + return
103 + }
104 +
105 + req.body = req.body || {}
106 +
107 + // skip requests without bodies
108 + if (!typeis.hasBody(req)) {
109 + debug('skip empty body')
110 + next()
111 + return
112 + }
113 +
114 + debug('content-type %j', req.headers['content-type'])
115 +
116 + // determine if request should be parsed
117 + if (!shouldParse(req)) {
118 + debug('skip parsing')
119 + next()
120 + return
121 + }
122 +
123 + // assert charset per RFC 7159 sec 8.1
124 + var charset = getCharset(req) || 'utf-8'
125 + if (charset.substr(0, 4) !== 'utf-') {
126 + debug('invalid charset')
127 + next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
128 + charset: charset,
129 + type: 'charset.unsupported'
130 + }))
131 + return
132 + }
133 +
134 + // read
135 + read(req, res, next, parse, debug, {
136 + encoding: charset,
137 + inflate: inflate,
138 + limit: limit,
139 + verify: verify
140 + })
141 + }
142 +}
143 +
144 +/**
145 + * Create strict violation syntax error matching native error.
146 + *
147 + * @param {string} str
148 + * @param {string} char
149 + * @return {Error}
150 + * @private
151 + */
152 +
153 +function createStrictSyntaxError (str, char) {
154 + var index = str.indexOf(char)
155 + var partial = str.substring(0, index) + '#'
156 +
157 + try {
158 + JSON.parse(partial); /* istanbul ignore next */ throw new SyntaxError('strict violation')
159 + } catch (e) {
160 + return normalizeJsonSyntaxError(e, {
161 + message: e.message.replace('#', char),
162 + stack: e.stack
163 + })
164 + }
165 +}
166 +
167 +/**
168 + * Get the first non-whitespace character in a string.
169 + *
170 + * @param {string} str
171 + * @return {function}
172 + * @private
173 + */
174 +
175 +function firstchar (str) {
176 + return FIRST_CHAR_REGEXP.exec(str)[1]
177 +}
178 +
179 +/**
180 + * Get the charset of a request.
181 + *
182 + * @param {object} req
183 + * @api private
184 + */
185 +
186 +function getCharset (req) {
187 + try {
188 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
189 + } catch (e) {
190 + return undefined
191 + }
192 +}
193 +
194 +/**
195 + * Normalize a SyntaxError for JSON.parse.
196 + *
197 + * @param {SyntaxError} error
198 + * @param {object} obj
199 + * @return {SyntaxError}
200 + */
201 +
202 +function normalizeJsonSyntaxError (error, obj) {
203 + var keys = Object.getOwnPropertyNames(error)
204 +
205 + for (var i = 0; i < keys.length; i++) {
206 + var key = keys[i]
207 + if (key !== 'stack' && key !== 'message') {
208 + delete error[key]
209 + }
210 + }
211 +
212 + // replace stack before message for Node.js 0.10 and below
213 + error.stack = obj.stack.replace(error.message, obj.message)
214 + error.message = obj.message
215 +
216 + return error
217 +}
218 +
219 +/**
220 + * Get the simple type checker.
221 + *
222 + * @param {string} type
223 + * @return {function}
224 + */
225 +
226 +function typeChecker (type) {
227 + return function checkType (req) {
228 + return Boolean(typeis(req, type))
229 + }
230 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + */
12 +
13 +var bytes = require('bytes')
14 +var debug = require('debug')('body-parser:raw')
15 +var read = require('../read')
16 +var typeis = require('type-is')
17 +
18 +/**
19 + * Module exports.
20 + */
21 +
22 +module.exports = raw
23 +
24 +/**
25 + * Create a middleware to parse raw bodies.
26 + *
27 + * @param {object} [options]
28 + * @return {function}
29 + * @api public
30 + */
31 +
32 +function raw (options) {
33 + var opts = options || {}
34 +
35 + var inflate = opts.inflate !== false
36 + var limit = typeof opts.limit !== 'number'
37 + ? bytes.parse(opts.limit || '100kb')
38 + : opts.limit
39 + var type = opts.type || 'application/octet-stream'
40 + var verify = opts.verify || false
41 +
42 + if (verify !== false && typeof verify !== 'function') {
43 + throw new TypeError('option verify must be function')
44 + }
45 +
46 + // create the appropriate type checking function
47 + var shouldParse = typeof type !== 'function'
48 + ? typeChecker(type)
49 + : type
50 +
51 + function parse (buf) {
52 + return buf
53 + }
54 +
55 + return function rawParser (req, res, next) {
56 + if (req._body) {
57 + debug('body already parsed')
58 + next()
59 + return
60 + }
61 +
62 + req.body = req.body || {}
63 +
64 + // skip requests without bodies
65 + if (!typeis.hasBody(req)) {
66 + debug('skip empty body')
67 + next()
68 + return
69 + }
70 +
71 + debug('content-type %j', req.headers['content-type'])
72 +
73 + // determine if request should be parsed
74 + if (!shouldParse(req)) {
75 + debug('skip parsing')
76 + next()
77 + return
78 + }
79 +
80 + // read
81 + read(req, res, next, parse, debug, {
82 + encoding: null,
83 + inflate: inflate,
84 + limit: limit,
85 + verify: verify
86 + })
87 + }
88 +}
89 +
90 +/**
91 + * Get the simple type checker.
92 + *
93 + * @param {string} type
94 + * @return {function}
95 + */
96 +
97 +function typeChecker (type) {
98 + return function checkType (req) {
99 + return Boolean(typeis(req, type))
100 + }
101 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + */
12 +
13 +var bytes = require('bytes')
14 +var contentType = require('content-type')
15 +var debug = require('debug')('body-parser:text')
16 +var read = require('../read')
17 +var typeis = require('type-is')
18 +
19 +/**
20 + * Module exports.
21 + */
22 +
23 +module.exports = text
24 +
25 +/**
26 + * Create a middleware to parse text bodies.
27 + *
28 + * @param {object} [options]
29 + * @return {function}
30 + * @api public
31 + */
32 +
33 +function text (options) {
34 + var opts = options || {}
35 +
36 + var defaultCharset = opts.defaultCharset || 'utf-8'
37 + var inflate = opts.inflate !== false
38 + var limit = typeof opts.limit !== 'number'
39 + ? bytes.parse(opts.limit || '100kb')
40 + : opts.limit
41 + var type = opts.type || 'text/plain'
42 + var verify = opts.verify || false
43 +
44 + if (verify !== false && typeof verify !== 'function') {
45 + throw new TypeError('option verify must be function')
46 + }
47 +
48 + // create the appropriate type checking function
49 + var shouldParse = typeof type !== 'function'
50 + ? typeChecker(type)
51 + : type
52 +
53 + function parse (buf) {
54 + return buf
55 + }
56 +
57 + return function textParser (req, res, next) {
58 + if (req._body) {
59 + debug('body already parsed')
60 + next()
61 + return
62 + }
63 +
64 + req.body = req.body || {}
65 +
66 + // skip requests without bodies
67 + if (!typeis.hasBody(req)) {
68 + debug('skip empty body')
69 + next()
70 + return
71 + }
72 +
73 + debug('content-type %j', req.headers['content-type'])
74 +
75 + // determine if request should be parsed
76 + if (!shouldParse(req)) {
77 + debug('skip parsing')
78 + next()
79 + return
80 + }
81 +
82 + // get charset
83 + var charset = getCharset(req) || defaultCharset
84 +
85 + // read
86 + read(req, res, next, parse, debug, {
87 + encoding: charset,
88 + inflate: inflate,
89 + limit: limit,
90 + verify: verify
91 + })
92 + }
93 +}
94 +
95 +/**
96 + * Get the charset of a request.
97 + *
98 + * @param {object} req
99 + * @api private
100 + */
101 +
102 +function getCharset (req) {
103 + try {
104 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
105 + } catch (e) {
106 + return undefined
107 + }
108 +}
109 +
110 +/**
111 + * Get the simple type checker.
112 + *
113 + * @param {string} type
114 + * @return {function}
115 + */
116 +
117 +function typeChecker (type) {
118 + return function checkType (req) {
119 + return Boolean(typeis(req, type))
120 + }
121 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var bytes = require('bytes')
16 +var contentType = require('content-type')
17 +var createError = require('http-errors')
18 +var debug = require('debug')('body-parser:urlencoded')
19 +var deprecate = require('depd')('body-parser')
20 +var read = require('../read')
21 +var typeis = require('type-is')
22 +
23 +/**
24 + * Module exports.
25 + */
26 +
27 +module.exports = urlencoded
28 +
29 +/**
30 + * Cache of parser modules.
31 + */
32 +
33 +var parsers = Object.create(null)
34 +
35 +/**
36 + * Create a middleware to parse urlencoded bodies.
37 + *
38 + * @param {object} [options]
39 + * @return {function}
40 + * @public
41 + */
42 +
43 +function urlencoded (options) {
44 + var opts = options || {}
45 +
46 + // notice because option default will flip in next major
47 + if (opts.extended === undefined) {
48 + deprecate('undefined extended: provide extended option')
49 + }
50 +
51 + var extended = opts.extended !== false
52 + var inflate = opts.inflate !== false
53 + var limit = typeof opts.limit !== 'number'
54 + ? bytes.parse(opts.limit || '100kb')
55 + : opts.limit
56 + var type = opts.type || 'application/x-www-form-urlencoded'
57 + var verify = opts.verify || false
58 +
59 + if (verify !== false && typeof verify !== 'function') {
60 + throw new TypeError('option verify must be function')
61 + }
62 +
63 + // create the appropriate query parser
64 + var queryparse = extended
65 + ? extendedparser(opts)
66 + : simpleparser(opts)
67 +
68 + // create the appropriate type checking function
69 + var shouldParse = typeof type !== 'function'
70 + ? typeChecker(type)
71 + : type
72 +
73 + function parse (body) {
74 + return body.length
75 + ? queryparse(body)
76 + : {}
77 + }
78 +
79 + return function urlencodedParser (req, res, next) {
80 + if (req._body) {
81 + debug('body already parsed')
82 + next()
83 + return
84 + }
85 +
86 + req.body = req.body || {}
87 +
88 + // skip requests without bodies
89 + if (!typeis.hasBody(req)) {
90 + debug('skip empty body')
91 + next()
92 + return
93 + }
94 +
95 + debug('content-type %j', req.headers['content-type'])
96 +
97 + // determine if request should be parsed
98 + if (!shouldParse(req)) {
99 + debug('skip parsing')
100 + next()
101 + return
102 + }
103 +
104 + // assert charset
105 + var charset = getCharset(req) || 'utf-8'
106 + if (charset !== 'utf-8') {
107 + debug('invalid charset')
108 + next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
109 + charset: charset,
110 + type: 'charset.unsupported'
111 + }))
112 + return
113 + }
114 +
115 + // read
116 + read(req, res, next, parse, debug, {
117 + debug: debug,
118 + encoding: charset,
119 + inflate: inflate,
120 + limit: limit,
121 + verify: verify
122 + })
123 + }
124 +}
125 +
126 +/**
127 + * Get the extended query parser.
128 + *
129 + * @param {object} options
130 + */
131 +
132 +function extendedparser (options) {
133 + var parameterLimit = options.parameterLimit !== undefined
134 + ? options.parameterLimit
135 + : 1000
136 + var parse = parser('qs')
137 +
138 + if (isNaN(parameterLimit) || parameterLimit < 1) {
139 + throw new TypeError('option parameterLimit must be a positive number')
140 + }
141 +
142 + if (isFinite(parameterLimit)) {
143 + parameterLimit = parameterLimit | 0
144 + }
145 +
146 + return function queryparse (body) {
147 + var paramCount = parameterCount(body, parameterLimit)
148 +
149 + if (paramCount === undefined) {
150 + debug('too many parameters')
151 + throw createError(413, 'too many parameters', {
152 + type: 'parameters.too.many'
153 + })
154 + }
155 +
156 + var arrayLimit = Math.max(100, paramCount)
157 +
158 + debug('parse extended urlencoding')
159 + return parse(body, {
160 + allowPrototypes: true,
161 + arrayLimit: arrayLimit,
162 + depth: Infinity,
163 + parameterLimit: parameterLimit
164 + })
165 + }
166 +}
167 +
168 +/**
169 + * Get the charset of a request.
170 + *
171 + * @param {object} req
172 + * @api private
173 + */
174 +
175 +function getCharset (req) {
176 + try {
177 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
178 + } catch (e) {
179 + return undefined
180 + }
181 +}
182 +
183 +/**
184 + * Count the number of parameters, stopping once limit reached
185 + *
186 + * @param {string} body
187 + * @param {number} limit
188 + * @api private
189 + */
190 +
191 +function parameterCount (body, limit) {
192 + var count = 0
193 + var index = 0
194 +
195 + while ((index = body.indexOf('&', index)) !== -1) {
196 + count++
197 + index++
198 +
199 + if (count === limit) {
200 + return undefined
201 + }
202 + }
203 +
204 + return count
205 +}
206 +
207 +/**
208 + * Get parser for module name dynamically.
209 + *
210 + * @param {string} name
211 + * @return {function}
212 + * @api private
213 + */
214 +
215 +function parser (name) {
216 + var mod = parsers[name]
217 +
218 + if (mod !== undefined) {
219 + return mod.parse
220 + }
221 +
222 + // this uses a switch for static require analysis
223 + switch (name) {
224 + case 'qs':
225 + mod = require('qs')
226 + break
227 + case 'querystring':
228 + mod = require('querystring')
229 + break
230 + }
231 +
232 + // store to prevent invoking require()
233 + parsers[name] = mod
234 +
235 + return mod.parse
236 +}
237 +
238 +/**
239 + * Get the simple query parser.
240 + *
241 + * @param {object} options
242 + */
243 +
244 +function simpleparser (options) {
245 + var parameterLimit = options.parameterLimit !== undefined
246 + ? options.parameterLimit
247 + : 1000
248 + var parse = parser('querystring')
249 +
250 + if (isNaN(parameterLimit) || parameterLimit < 1) {
251 + throw new TypeError('option parameterLimit must be a positive number')
252 + }
253 +
254 + if (isFinite(parameterLimit)) {
255 + parameterLimit = parameterLimit | 0
256 + }
257 +
258 + return function queryparse (body) {
259 + var paramCount = parameterCount(body, parameterLimit)
260 +
261 + if (paramCount === undefined) {
262 + debug('too many parameters')
263 + throw createError(413, 'too many parameters', {
264 + type: 'parameters.too.many'
265 + })
266 + }
267 +
268 + debug('parse urlencoding')
269 + return parse(body, undefined, undefined, { maxKeys: parameterLimit })
270 + }
271 +}
272 +
273 +/**
274 + * Get the simple type checker.
275 + *
276 + * @param {string} type
277 + * @return {function}
278 + */
279 +
280 +function typeChecker (type) {
281 + return function checkType (req) {
282 + return Boolean(typeis(req, type))
283 + }
284 +}
1 +{
2 + "_from": "body-parser",
3 + "_id": "body-parser@1.19.0",
4 + "_inBundle": false,
5 + "_integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==",
6 + "_location": "/body-parser",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "tag",
10 + "registry": true,
11 + "raw": "body-parser",
12 + "name": "body-parser",
13 + "escapedName": "body-parser",
14 + "rawSpec": "",
15 + "saveSpec": null,
16 + "fetchSpec": "latest"
17 + },
18 + "_requiredBy": [
19 + "#USER",
20 + "/"
21 + ],
22 + "_resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz",
23 + "_shasum": "96b2709e57c9c4e09a6fd66a8fd979844f69f08a",
24 + "_spec": "body-parser",
25 + "_where": "/Users/mindyeoi/Desktop/We-Shop",
26 + "bugs": {
27 + "url": "https://github.com/expressjs/body-parser/issues"
28 + },
29 + "bundleDependencies": false,
30 + "contributors": [
31 + {
32 + "name": "Douglas Christopher Wilson",
33 + "email": "doug@somethingdoug.com"
34 + },
35 + {
36 + "name": "Jonathan Ong",
37 + "email": "me@jongleberry.com",
38 + "url": "http://jongleberry.com"
39 + }
40 + ],
41 + "dependencies": {
42 + "bytes": "3.1.0",
43 + "content-type": "~1.0.4",
44 + "debug": "2.6.9",
45 + "depd": "~1.1.2",
46 + "http-errors": "1.7.2",
47 + "iconv-lite": "0.4.24",
48 + "on-finished": "~2.3.0",
49 + "qs": "6.7.0",
50 + "raw-body": "2.4.0",
51 + "type-is": "~1.6.17"
52 + },
53 + "deprecated": false,
54 + "description": "Node.js body parsing middleware",
55 + "devDependencies": {
56 + "eslint": "5.16.0",
57 + "eslint-config-standard": "12.0.0",
58 + "eslint-plugin-import": "2.17.2",
59 + "eslint-plugin-markdown": "1.0.0",
60 + "eslint-plugin-node": "8.0.1",
61 + "eslint-plugin-promise": "4.1.1",
62 + "eslint-plugin-standard": "4.0.0",
63 + "istanbul": "0.4.5",
64 + "methods": "1.1.2",
65 + "mocha": "6.1.4",
66 + "safe-buffer": "5.1.2",
67 + "supertest": "4.0.2"
68 + },
69 + "engines": {
70 + "node": ">= 0.8"
71 + },
72 + "files": [
73 + "lib/",
74 + "LICENSE",
75 + "HISTORY.md",
76 + "index.js"
77 + ],
78 + "homepage": "https://github.com/expressjs/body-parser#readme",
79 + "license": "MIT",
80 + "name": "body-parser",
81 + "repository": {
82 + "type": "git",
83 + "url": "git+https://github.com/expressjs/body-parser.git"
84 + },
85 + "scripts": {
86 + "lint": "eslint --plugin markdown --ext js,md .",
87 + "test": "mocha --require test/support/env --reporter spec --check-leaks --bail test/",
88 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/",
89 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/"
90 + },
91 + "version": "1.19.0"
92 +}
1 +3.1.0 / 2019-01-22
2 +==================
3 +
4 + * Add petabyte (`pb`) support
5 +
6 +3.0.0 / 2017-08-31
7 +==================
8 +
9 + * Change "kB" to "KB" in format output
10 + * Remove support for Node.js 0.6
11 + * Remove support for ComponentJS
12 +
13 +2.5.0 / 2017-03-24
14 +==================
15 +
16 + * Add option "unit"
17 +
18 +2.4.0 / 2016-06-01
19 +==================
20 +
21 + * Add option "unitSeparator"
22 +
23 +2.3.0 / 2016-02-15
24 +==================
25 +
26 + * Drop partial bytes on all parsed units
27 + * Fix non-finite numbers to `.format` to return `null`
28 + * Fix parsing byte string that looks like hex
29 + * perf: hoist regular expressions
30 +
31 +2.2.0 / 2015-11-13
32 +==================
33 +
34 + * add option "decimalPlaces"
35 + * add option "fixedDecimals"
36 +
37 +2.1.0 / 2015-05-21
38 +==================
39 +
40 + * add `.format` export
41 + * add `.parse` export
42 +
43 +2.0.2 / 2015-05-20
44 +==================
45 +
46 + * remove map recreation
47 + * remove unnecessary object construction
48 +
49 +2.0.1 / 2015-05-07
50 +==================
51 +
52 + * fix browserify require
53 + * remove node.extend dependency
54 +
55 +2.0.0 / 2015-04-12
56 +==================
57 +
58 + * add option "case"
59 + * add option "thousandsSeparator"
60 + * return "null" on invalid parse input
61 + * support proper round-trip: bytes(bytes(num)) === num
62 + * units no longer case sensitive when parsing
63 +
64 +1.0.0 / 2014-05-05
65 +==================
66 +
67 + * add negative support. fixes #6
68 +
69 +0.3.0 / 2014-03-19
70 +==================
71 +
72 + * added terabyte support
73 +
74 +0.2.1 / 2013-04-01
75 +==================
76 +
77 + * add .component
78 +
79 +0.2.0 / 2012-10-28
80 +==================
81 +
82 + * bytes(200).should.eql('200b')
83 +
84 +0.1.0 / 2012-07-04
85 +==================
86 +
87 + * add bytes to string conversion [yields]
1 +(The MIT License)
2 +
3 +Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
4 +Copyright (c) 2015 Jed Watson <jed.watson@me.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# Bytes utility
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Build Status][travis-image]][travis-url]
6 +[![Test Coverage][coveralls-image]][coveralls-url]
7 +
8 +Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
9 +
10 +## Installation
11 +
12 +This is a [Node.js](https://nodejs.org/en/) module available through the
13 +[npm registry](https://www.npmjs.com/). Installation is done using the
14 +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
15 +
16 +```bash
17 +$ npm install bytes
18 +```
19 +
20 +## Usage
21 +
22 +```js
23 +var bytes = require('bytes');
24 +```
25 +
26 +#### bytes.format(number value, [options]): string|null
27 +
28 +Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is
29 + rounded.
30 +
31 +**Arguments**
32 +
33 +| Name | Type | Description |
34 +|---------|----------|--------------------|
35 +| value | `number` | Value in bytes |
36 +| options | `Object` | Conversion options |
37 +
38 +**Options**
39 +
40 +| Property | Type | Description |
41 +|-------------------|--------|-----------------------------------------------------------------------------------------|
42 +| decimalPlaces | `number``null` | Maximum number of decimal places to include in output. Default value to `2`. |
43 +| fixedDecimals | `boolean``null` | Whether to always display the maximum number of decimal places. Default value to `false` |
44 +| thousandsSeparator | `string``null` | Example of values: `' '`, `','` and `.`... Default value to `''`. |
45 +| unit | `string``null` | The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to `''` (which means auto detect). |
46 +| unitSeparator | `string``null` | Separator to use between number and unit. Default value to `''`. |
47 +
48 +**Returns**
49 +
50 +| Name | Type | Description |
51 +|---------|------------------|-------------------------------------------------|
52 +| results | `string``null` | Return null upon error. String value otherwise. |
53 +
54 +**Example**
55 +
56 +```js
57 +bytes(1024);
58 +// output: '1KB'
59 +
60 +bytes(1000);
61 +// output: '1000B'
62 +
63 +bytes(1000, {thousandsSeparator: ' '});
64 +// output: '1 000B'
65 +
66 +bytes(1024 * 1.7, {decimalPlaces: 0});
67 +// output: '2KB'
68 +
69 +bytes(1024, {unitSeparator: ' '});
70 +// output: '1 KB'
71 +
72 +```
73 +
74 +#### bytes.parse(string|number value): number|null
75 +
76 +Parse the string value into an integer in bytes. If no unit is given, or `value`
77 +is a number, it is assumed the value is in bytes.
78 +
79 +Supported units and abbreviations are as follows and are case-insensitive:
80 +
81 + * `b` for bytes
82 + * `kb` for kilobytes
83 + * `mb` for megabytes
84 + * `gb` for gigabytes
85 + * `tb` for terabytes
86 + * `pb` for petabytes
87 +
88 +The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.
89 +
90 +**Arguments**
91 +
92 +| Name | Type | Description |
93 +|---------------|--------|--------------------|
94 +| value | `string``number` | String to parse, or number in bytes. |
95 +
96 +**Returns**
97 +
98 +| Name | Type | Description |
99 +|---------|-------------|-------------------------|
100 +| results | `number``null` | Return null upon error. Value in bytes otherwise. |
101 +
102 +**Example**
103 +
104 +```js
105 +bytes('1KB');
106 +// output: 1024
107 +
108 +bytes('1024');
109 +// output: 1024
110 +
111 +bytes(1024);
112 +// output: 1KB
113 +```
114 +
115 +## License
116 +
117 +[MIT](LICENSE)
118 +
119 +[coveralls-image]: https://badgen.net/coveralls/c/github/visionmedia/bytes.js/master
120 +[coveralls-url]: https://coveralls.io/r/visionmedia/bytes.js?branch=master
121 +[downloads-image]: https://badgen.net/npm/dm/bytes
122 +[downloads-url]: https://npmjs.org/package/bytes
123 +[npm-image]: https://badgen.net/npm/node/bytes
124 +[npm-url]: https://npmjs.org/package/bytes
125 +[travis-image]: https://badgen.net/travis/visionmedia/bytes.js/master
126 +[travis-url]: https://travis-ci.org/visionmedia/bytes.js
1 +/*!
2 + * bytes
3 + * Copyright(c) 2012-2014 TJ Holowaychuk
4 + * Copyright(c) 2015 Jed Watson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict';
9 +
10 +/**
11 + * Module exports.
12 + * @public
13 + */
14 +
15 +module.exports = bytes;
16 +module.exports.format = format;
17 +module.exports.parse = parse;
18 +
19 +/**
20 + * Module variables.
21 + * @private
22 + */
23 +
24 +var formatThousandsRegExp = /\B(?=(\d{3})+(?!\d))/g;
25 +
26 +var formatDecimalsRegExp = /(?:\.0*|(\.[^0]+)0+)$/;
27 +
28 +var map = {
29 + b: 1,
30 + kb: 1 << 10,
31 + mb: 1 << 20,
32 + gb: 1 << 30,
33 + tb: Math.pow(1024, 4),
34 + pb: Math.pow(1024, 5),
35 +};
36 +
37 +var parseRegExp = /^((-|\+)?(\d+(?:\.\d+)?)) *(kb|mb|gb|tb|pb)$/i;
38 +
39 +/**
40 + * Convert the given value in bytes into a string or parse to string to an integer in bytes.
41 + *
42 + * @param {string|number} value
43 + * @param {{
44 + * case: [string],
45 + * decimalPlaces: [number]
46 + * fixedDecimals: [boolean]
47 + * thousandsSeparator: [string]
48 + * unitSeparator: [string]
49 + * }} [options] bytes options.
50 + *
51 + * @returns {string|number|null}
52 + */
53 +
54 +function bytes(value, options) {
55 + if (typeof value === 'string') {
56 + return parse(value);
57 + }
58 +
59 + if (typeof value === 'number') {
60 + return format(value, options);
61 + }
62 +
63 + return null;
64 +}
65 +
66 +/**
67 + * Format the given value in bytes into a string.
68 + *
69 + * If the value is negative, it is kept as such. If it is a float,
70 + * it is rounded.
71 + *
72 + * @param {number} value
73 + * @param {object} [options]
74 + * @param {number} [options.decimalPlaces=2]
75 + * @param {number} [options.fixedDecimals=false]
76 + * @param {string} [options.thousandsSeparator=]
77 + * @param {string} [options.unit=]
78 + * @param {string} [options.unitSeparator=]
79 + *
80 + * @returns {string|null}
81 + * @public
82 + */
83 +
84 +function format(value, options) {
85 + if (!Number.isFinite(value)) {
86 + return null;
87 + }
88 +
89 + var mag = Math.abs(value);
90 + var thousandsSeparator = (options && options.thousandsSeparator) || '';
91 + var unitSeparator = (options && options.unitSeparator) || '';
92 + var decimalPlaces = (options && options.decimalPlaces !== undefined) ? options.decimalPlaces : 2;
93 + var fixedDecimals = Boolean(options && options.fixedDecimals);
94 + var unit = (options && options.unit) || '';
95 +
96 + if (!unit || !map[unit.toLowerCase()]) {
97 + if (mag >= map.pb) {
98 + unit = 'PB';
99 + } else if (mag >= map.tb) {
100 + unit = 'TB';
101 + } else if (mag >= map.gb) {
102 + unit = 'GB';
103 + } else if (mag >= map.mb) {
104 + unit = 'MB';
105 + } else if (mag >= map.kb) {
106 + unit = 'KB';
107 + } else {
108 + unit = 'B';
109 + }
110 + }
111 +
112 + var val = value / map[unit.toLowerCase()];
113 + var str = val.toFixed(decimalPlaces);
114 +
115 + if (!fixedDecimals) {
116 + str = str.replace(formatDecimalsRegExp, '$1');
117 + }
118 +
119 + if (thousandsSeparator) {
120 + str = str.replace(formatThousandsRegExp, thousandsSeparator);
121 + }
122 +
123 + return str + unitSeparator + unit;
124 +}
125 +
126 +/**
127 + * Parse the string value into an integer in bytes.
128 + *
129 + * If no unit is given, it is assumed the value is in bytes.
130 + *
131 + * @param {number|string} val
132 + *
133 + * @returns {number|null}
134 + * @public
135 + */
136 +
137 +function parse(val) {
138 + if (typeof val === 'number' && !isNaN(val)) {
139 + return val;
140 + }
141 +
142 + if (typeof val !== 'string') {
143 + return null;
144 + }
145 +
146 + // Test if the string passed is valid
147 + var results = parseRegExp.exec(val);
148 + var floatValue;
149 + var unit = 'b';
150 +
151 + if (!results) {
152 + // Nothing could be extracted from the given string
153 + floatValue = parseInt(val, 10);
154 + unit = 'b'
155 + } else {
156 + // Retrieve the value and the unit
157 + floatValue = parseFloat(results[1]);
158 + unit = results[4].toLowerCase();
159 + }
160 +
161 + return Math.floor(map[unit] * floatValue);
162 +}
1 +{
2 + "_from": "bytes@3.1.0",
3 + "_id": "bytes@3.1.0",
4 + "_inBundle": false,
5 + "_integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==",
6 + "_location": "/bytes",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "version",
10 + "registry": true,
11 + "raw": "bytes@3.1.0",
12 + "name": "bytes",
13 + "escapedName": "bytes",
14 + "rawSpec": "3.1.0",
15 + "saveSpec": null,
16 + "fetchSpec": "3.1.0"
17 + },
18 + "_requiredBy": [
19 + "/body-parser",
20 + "/raw-body"
21 + ],
22 + "_resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz",
23 + "_shasum": "f6cf7933a360e0588fa9fde85651cdc7f805d1f6",
24 + "_spec": "bytes@3.1.0",
25 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/body-parser",
26 + "author": {
27 + "name": "TJ Holowaychuk",
28 + "email": "tj@vision-media.ca",
29 + "url": "http://tjholowaychuk.com"
30 + },
31 + "bugs": {
32 + "url": "https://github.com/visionmedia/bytes.js/issues"
33 + },
34 + "bundleDependencies": false,
35 + "contributors": [
36 + {
37 + "name": "Jed Watson",
38 + "email": "jed.watson@me.com"
39 + },
40 + {
41 + "name": "Théo FIDRY",
42 + "email": "theo.fidry@gmail.com"
43 + }
44 + ],
45 + "deprecated": false,
46 + "description": "Utility to parse a string bytes to bytes and vice-versa",
47 + "devDependencies": {
48 + "eslint": "5.12.1",
49 + "mocha": "5.2.0",
50 + "nyc": "13.1.0"
51 + },
52 + "engines": {
53 + "node": ">= 0.8"
54 + },
55 + "files": [
56 + "History.md",
57 + "LICENSE",
58 + "Readme.md",
59 + "index.js"
60 + ],
61 + "homepage": "https://github.com/visionmedia/bytes.js#readme",
62 + "keywords": [
63 + "byte",
64 + "bytes",
65 + "utility",
66 + "parse",
67 + "parser",
68 + "convert",
69 + "converter"
70 + ],
71 + "license": "MIT",
72 + "name": "bytes",
73 + "repository": {
74 + "type": "git",
75 + "url": "git+https://github.com/visionmedia/bytes.js.git"
76 + },
77 + "scripts": {
78 + "lint": "eslint .",
79 + "test": "mocha --check-leaks --reporter spec",
80 + "test-ci": "nyc --reporter=text npm test",
81 + "test-cov": "nyc --reporter=html --reporter=text npm test"
82 + },
83 + "version": "3.1.0"
84 +}
1 +1.0.4 / 2017-09-11
2 +==================
3 +
4 + * perf: skip parameter parsing when no parameters
5 +
6 +1.0.3 / 2017-09-10
7 +==================
8 +
9 + * perf: remove argument reassignment
10 +
11 +1.0.2 / 2016-05-09
12 +==================
13 +
14 + * perf: enable strict mode
15 +
16 +1.0.1 / 2015-02-13
17 +==================
18 +
19 + * Improve missing `Content-Type` header error message
20 +
21 +1.0.0 / 2015-02-01
22 +==================
23 +
24 + * Initial implementation, derived from `media-typer@0.3.0`
1 +(The MIT License)
2 +
3 +Copyright (c) 2015 Douglas Christopher Wilson
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining
6 +a copy of this software and associated documentation files (the
7 +'Software'), to deal in the Software without restriction, including
8 +without limitation the rights to use, copy, modify, merge, publish,
9 +distribute, sublicense, and/or sell copies of the Software, and to
10 +permit persons to whom the Software is furnished to do so, subject to
11 +the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be
14 +included in all copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# content-type
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Node.js Version][node-version-image]][node-version-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Create and parse HTTP Content-Type header according to RFC 7231
10 +
11 +## Installation
12 +
13 +```sh
14 +$ npm install content-type
15 +```
16 +
17 +## API
18 +
19 +```js
20 +var contentType = require('content-type')
21 +```
22 +
23 +### contentType.parse(string)
24 +
25 +```js
26 +var obj = contentType.parse('image/svg+xml; charset=utf-8')
27 +```
28 +
29 +Parse a content type string. This will return an object with the following
30 +properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
31 +
32 + - `type`: The media type (the type and subtype, always lower case).
33 + Example: `'image/svg+xml'`
34 +
35 + - `parameters`: An object of the parameters in the media type (name of parameter
36 + always lower case). Example: `{charset: 'utf-8'}`
37 +
38 +Throws a `TypeError` if the string is missing or invalid.
39 +
40 +### contentType.parse(req)
41 +
42 +```js
43 +var obj = contentType.parse(req)
44 +```
45 +
46 +Parse the `content-type` header from the given `req`. Short-cut for
47 +`contentType.parse(req.headers['content-type'])`.
48 +
49 +Throws a `TypeError` if the `Content-Type` header is missing or invalid.
50 +
51 +### contentType.parse(res)
52 +
53 +```js
54 +var obj = contentType.parse(res)
55 +```
56 +
57 +Parse the `content-type` header set on the given `res`. Short-cut for
58 +`contentType.parse(res.getHeader('content-type'))`.
59 +
60 +Throws a `TypeError` if the `Content-Type` header is missing or invalid.
61 +
62 +### contentType.format(obj)
63 +
64 +```js
65 +var str = contentType.format({type: 'image/svg+xml'})
66 +```
67 +
68 +Format an object into a content type string. This will return a string of the
69 +content type for the given object with the following properties (examples are
70 +shown that produce the string `'image/svg+xml; charset=utf-8'`):
71 +
72 + - `type`: The media type (will be lower-cased). Example: `'image/svg+xml'`
73 +
74 + - `parameters`: An object of the parameters in the media type (name of the
75 + parameter will be lower-cased). Example: `{charset: 'utf-8'}`
76 +
77 +Throws a `TypeError` if the object contains an invalid type or parameter names.
78 +
79 +## License
80 +
81 +[MIT](LICENSE)
82 +
83 +[npm-image]: https://img.shields.io/npm/v/content-type.svg
84 +[npm-url]: https://npmjs.org/package/content-type
85 +[node-version-image]: https://img.shields.io/node/v/content-type.svg
86 +[node-version-url]: http://nodejs.org/download/
87 +[travis-image]: https://img.shields.io/travis/jshttp/content-type/master.svg
88 +[travis-url]: https://travis-ci.org/jshttp/content-type
89 +[coveralls-image]: https://img.shields.io/coveralls/jshttp/content-type/master.svg
90 +[coveralls-url]: https://coveralls.io/r/jshttp/content-type
91 +[downloads-image]: https://img.shields.io/npm/dm/content-type.svg
92 +[downloads-url]: https://npmjs.org/package/content-type
1 +/*!
2 + * content-type
3 + * Copyright(c) 2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * RegExp to match *( ";" parameter ) in RFC 7231 sec 3.1.1.1
11 + *
12 + * parameter = token "=" ( token / quoted-string )
13 + * token = 1*tchar
14 + * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
15 + * / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
16 + * / DIGIT / ALPHA
17 + * ; any VCHAR, except delimiters
18 + * quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE
19 + * qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
20 + * obs-text = %x80-FF
21 + * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
22 + */
23 +var PARAM_REGEXP = /; *([!#$%&'*+.^_`|~0-9A-Za-z-]+) *= *("(?:[\u000b\u0020\u0021\u0023-\u005b\u005d-\u007e\u0080-\u00ff]|\\[\u000b\u0020-\u00ff])*"|[!#$%&'*+.^_`|~0-9A-Za-z-]+) */g
24 +var TEXT_REGEXP = /^[\u000b\u0020-\u007e\u0080-\u00ff]+$/
25 +var TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
26 +
27 +/**
28 + * RegExp to match quoted-pair in RFC 7230 sec 3.2.6
29 + *
30 + * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
31 + * obs-text = %x80-FF
32 + */
33 +var QESC_REGEXP = /\\([\u000b\u0020-\u00ff])/g
34 +
35 +/**
36 + * RegExp to match chars that must be quoted-pair in RFC 7230 sec 3.2.6
37 + */
38 +var QUOTE_REGEXP = /([\\"])/g
39 +
40 +/**
41 + * RegExp to match type in RFC 7231 sec 3.1.1.1
42 + *
43 + * media-type = type "/" subtype
44 + * type = token
45 + * subtype = token
46 + */
47 +var TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
48 +
49 +/**
50 + * Module exports.
51 + * @public
52 + */
53 +
54 +exports.format = format
55 +exports.parse = parse
56 +
57 +/**
58 + * Format object to media type.
59 + *
60 + * @param {object} obj
61 + * @return {string}
62 + * @public
63 + */
64 +
65 +function format (obj) {
66 + if (!obj || typeof obj !== 'object') {
67 + throw new TypeError('argument obj is required')
68 + }
69 +
70 + var parameters = obj.parameters
71 + var type = obj.type
72 +
73 + if (!type || !TYPE_REGEXP.test(type)) {
74 + throw new TypeError('invalid type')
75 + }
76 +
77 + var string = type
78 +
79 + // append parameters
80 + if (parameters && typeof parameters === 'object') {
81 + var param
82 + var params = Object.keys(parameters).sort()
83 +
84 + for (var i = 0; i < params.length; i++) {
85 + param = params[i]
86 +
87 + if (!TOKEN_REGEXP.test(param)) {
88 + throw new TypeError('invalid parameter name')
89 + }
90 +
91 + string += '; ' + param + '=' + qstring(parameters[param])
92 + }
93 + }
94 +
95 + return string
96 +}
97 +
98 +/**
99 + * Parse media type to object.
100 + *
101 + * @param {string|object} string
102 + * @return {Object}
103 + * @public
104 + */
105 +
106 +function parse (string) {
107 + if (!string) {
108 + throw new TypeError('argument string is required')
109 + }
110 +
111 + // support req/res-like objects as argument
112 + var header = typeof string === 'object'
113 + ? getcontenttype(string)
114 + : string
115 +
116 + if (typeof header !== 'string') {
117 + throw new TypeError('argument string is required to be a string')
118 + }
119 +
120 + var index = header.indexOf(';')
121 + var type = index !== -1
122 + ? header.substr(0, index).trim()
123 + : header.trim()
124 +
125 + if (!TYPE_REGEXP.test(type)) {
126 + throw new TypeError('invalid media type')
127 + }
128 +
129 + var obj = new ContentType(type.toLowerCase())
130 +
131 + // parse parameters
132 + if (index !== -1) {
133 + var key
134 + var match
135 + var value
136 +
137 + PARAM_REGEXP.lastIndex = index
138 +
139 + while ((match = PARAM_REGEXP.exec(header))) {
140 + if (match.index !== index) {
141 + throw new TypeError('invalid parameter format')
142 + }
143 +
144 + index += match[0].length
145 + key = match[1].toLowerCase()
146 + value = match[2]
147 +
148 + if (value[0] === '"') {
149 + // remove quotes and escapes
150 + value = value
151 + .substr(1, value.length - 2)
152 + .replace(QESC_REGEXP, '$1')
153 + }
154 +
155 + obj.parameters[key] = value
156 + }
157 +
158 + if (index !== header.length) {
159 + throw new TypeError('invalid parameter format')
160 + }
161 + }
162 +
163 + return obj
164 +}
165 +
166 +/**
167 + * Get content-type from req/res objects.
168 + *
169 + * @param {object}
170 + * @return {Object}
171 + * @private
172 + */
173 +
174 +function getcontenttype (obj) {
175 + var header
176 +
177 + if (typeof obj.getHeader === 'function') {
178 + // res-like
179 + header = obj.getHeader('content-type')
180 + } else if (typeof obj.headers === 'object') {
181 + // req-like
182 + header = obj.headers && obj.headers['content-type']
183 + }
184 +
185 + if (typeof header !== 'string') {
186 + throw new TypeError('content-type header is missing from object')
187 + }
188 +
189 + return header
190 +}
191 +
192 +/**
193 + * Quote a string if necessary.
194 + *
195 + * @param {string} val
196 + * @return {string}
197 + * @private
198 + */
199 +
200 +function qstring (val) {
201 + var str = String(val)
202 +
203 + // no need to quote tokens
204 + if (TOKEN_REGEXP.test(str)) {
205 + return str
206 + }
207 +
208 + if (str.length > 0 && !TEXT_REGEXP.test(str)) {
209 + throw new TypeError('invalid parameter value')
210 + }
211 +
212 + return '"' + str.replace(QUOTE_REGEXP, '\\$1') + '"'
213 +}
214 +
215 +/**
216 + * Class to represent a content type.
217 + * @private
218 + */
219 +function ContentType (type) {
220 + this.parameters = Object.create(null)
221 + this.type = type
222 +}
1 +{
2 + "_from": "content-type@~1.0.4",
3 + "_id": "content-type@1.0.4",
4 + "_inBundle": false,
5 + "_integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==",
6 + "_location": "/content-type",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "range",
10 + "registry": true,
11 + "raw": "content-type@~1.0.4",
12 + "name": "content-type",
13 + "escapedName": "content-type",
14 + "rawSpec": "~1.0.4",
15 + "saveSpec": null,
16 + "fetchSpec": "~1.0.4"
17 + },
18 + "_requiredBy": [
19 + "/body-parser"
20 + ],
21 + "_resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz",
22 + "_shasum": "e138cc75e040c727b1966fe5e5f8c9aee256fe3b",
23 + "_spec": "content-type@~1.0.4",
24 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/body-parser",
25 + "author": {
26 + "name": "Douglas Christopher Wilson",
27 + "email": "doug@somethingdoug.com"
28 + },
29 + "bugs": {
30 + "url": "https://github.com/jshttp/content-type/issues"
31 + },
32 + "bundleDependencies": false,
33 + "deprecated": false,
34 + "description": "Create and parse HTTP Content-Type header",
35 + "devDependencies": {
36 + "eslint": "3.19.0",
37 + "eslint-config-standard": "10.2.1",
38 + "eslint-plugin-import": "2.7.0",
39 + "eslint-plugin-node": "5.1.1",
40 + "eslint-plugin-promise": "3.5.0",
41 + "eslint-plugin-standard": "3.0.1",
42 + "istanbul": "0.4.5",
43 + "mocha": "~1.21.5"
44 + },
45 + "engines": {
46 + "node": ">= 0.6"
47 + },
48 + "files": [
49 + "LICENSE",
50 + "HISTORY.md",
51 + "README.md",
52 + "index.js"
53 + ],
54 + "homepage": "https://github.com/jshttp/content-type#readme",
55 + "keywords": [
56 + "content-type",
57 + "http",
58 + "req",
59 + "res",
60 + "rfc7231"
61 + ],
62 + "license": "MIT",
63 + "name": "content-type",
64 + "repository": {
65 + "type": "git",
66 + "url": "git+https://github.com/jshttp/content-type.git"
67 + },
68 + "scripts": {
69 + "lint": "eslint .",
70 + "test": "mocha --reporter spec --check-leaks --bail test/",
71 + "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
72 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/"
73 + },
74 + "version": "1.0.4"
75 +}
1 +repo_token: SIAeZjKYlHK74rbcFvNHMUzjRiMpflxve
1 +{
2 + "env": {
3 + "browser": true,
4 + "node": true
5 + },
6 + "rules": {
7 + "no-console": 0,
8 + "no-empty": [1, { "allowEmptyCatch": true }]
9 + },
10 + "extends": "eslint:recommended"
11 +}
1 +support
2 +test
3 +examples
4 +example
5 +*.sock
6 +dist
7 +yarn.lock
8 +coverage
9 +bower.json
1 +
2 +language: node_js
3 +node_js:
4 + - "6"
5 + - "5"
6 + - "4"
7 +
8 +install:
9 + - make node_modules
10 +
11 +script:
12 + - make lint
13 + - make test
14 + - make coveralls
This diff is collapsed. Click to expand it.
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 TJ Holowaychuk <tj@vision-media.ca>
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining a copy of this software
6 +and associated documentation files (the 'Software'), to deal in the Software without restriction,
7 +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
9 +subject to the following conditions:
10 +
11 +The above copyright notice and this permission notice shall be included in all copies or substantial
12 +portions of the Software.
13 +
14 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
15 +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
17 +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
18 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19 +
1 +# get Makefile directory name: http://stackoverflow.com/a/5982798/376773
2 +THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
3 +THIS_DIR:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)
4 +
5 +# BIN directory
6 +BIN := $(THIS_DIR)/node_modules/.bin
7 +
8 +# Path
9 +PATH := node_modules/.bin:$(PATH)
10 +SHELL := /bin/bash
11 +
12 +# applications
13 +NODE ?= $(shell which node)
14 +YARN ?= $(shell which yarn)
15 +PKG ?= $(if $(YARN),$(YARN),$(NODE) $(shell which npm))
16 +BROWSERIFY ?= $(NODE) $(BIN)/browserify
17 +
18 +.FORCE:
19 +
20 +install: node_modules
21 +
22 +node_modules: package.json
23 + @NODE_ENV= $(PKG) install
24 + @touch node_modules
25 +
26 +lint: .FORCE
27 + eslint browser.js debug.js index.js node.js
28 +
29 +test-node: .FORCE
30 + istanbul cover node_modules/mocha/bin/_mocha -- test/**.js
31 +
32 +test-browser: .FORCE
33 + mkdir -p dist
34 +
35 + @$(BROWSERIFY) \
36 + --standalone debug \
37 + . > dist/debug.js
38 +
39 + karma start --single-run
40 + rimraf dist
41 +
42 +test: .FORCE
43 + concurrently \
44 + "make test-node" \
45 + "make test-browser"
46 +
47 +coveralls:
48 + cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
49 +
50 +.PHONY: all install clean distclean
This diff is collapsed. Click to expand it.
1 +{
2 + "name": "debug",
3 + "repo": "visionmedia/debug",
4 + "description": "small debugging utility",
5 + "version": "2.6.9",
6 + "keywords": [
7 + "debug",
8 + "log",
9 + "debugger"
10 + ],
11 + "main": "src/browser.js",
12 + "scripts": [
13 + "src/browser.js",
14 + "src/debug.js"
15 + ],
16 + "dependencies": {
17 + "rauchg/ms.js": "0.7.1"
18 + }
19 +}
1 +// Karma configuration
2 +// Generated on Fri Dec 16 2016 13:09:51 GMT+0000 (UTC)
3 +
4 +module.exports = function(config) {
5 + config.set({
6 +
7 + // base path that will be used to resolve all patterns (eg. files, exclude)
8 + basePath: '',
9 +
10 +
11 + // frameworks to use
12 + // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
13 + frameworks: ['mocha', 'chai', 'sinon'],
14 +
15 +
16 + // list of files / patterns to load in the browser
17 + files: [
18 + 'dist/debug.js',
19 + 'test/*spec.js'
20 + ],
21 +
22 +
23 + // list of files to exclude
24 + exclude: [
25 + 'src/node.js'
26 + ],
27 +
28 +
29 + // preprocess matching files before serving them to the browser
30 + // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
31 + preprocessors: {
32 + },
33 +
34 + // test results reporter to use
35 + // possible values: 'dots', 'progress'
36 + // available reporters: https://npmjs.org/browse/keyword/karma-reporter
37 + reporters: ['progress'],
38 +
39 +
40 + // web server port
41 + port: 9876,
42 +
43 +
44 + // enable / disable colors in the output (reporters and logs)
45 + colors: true,
46 +
47 +
48 + // level of logging
49 + // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
50 + logLevel: config.LOG_INFO,
51 +
52 +
53 + // enable / disable watching file and executing tests whenever any file changes
54 + autoWatch: true,
55 +
56 +
57 + // start these browsers
58 + // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
59 + browsers: ['PhantomJS'],
60 +
61 +
62 + // Continuous Integration mode
63 + // if true, Karma captures browsers, runs the tests and exits
64 + singleRun: false,
65 +
66 + // Concurrency level
67 + // how many browser should be started simultaneous
68 + concurrency: Infinity
69 + })
70 +}
1 +module.exports = require('./src/node');
1 +{
2 + "_from": "debug@2.6.9",
3 + "_id": "debug@2.6.9",
4 + "_inBundle": false,
5 + "_integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
6 + "_location": "/debug",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "version",
10 + "registry": true,
11 + "raw": "debug@2.6.9",
12 + "name": "debug",
13 + "escapedName": "debug",
14 + "rawSpec": "2.6.9",
15 + "saveSpec": null,
16 + "fetchSpec": "2.6.9"
17 + },
18 + "_requiredBy": [
19 + "/body-parser"
20 + ],
21 + "_resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
22 + "_shasum": "5d128515df134ff327e90a4c93f4e077a536341f",
23 + "_spec": "debug@2.6.9",
24 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/body-parser",
25 + "author": {
26 + "name": "TJ Holowaychuk",
27 + "email": "tj@vision-media.ca"
28 + },
29 + "browser": "./src/browser.js",
30 + "bugs": {
31 + "url": "https://github.com/visionmedia/debug/issues"
32 + },
33 + "bundleDependencies": false,
34 + "component": {
35 + "scripts": {
36 + "debug/index.js": "browser.js",
37 + "debug/debug.js": "debug.js"
38 + }
39 + },
40 + "contributors": [
41 + {
42 + "name": "Nathan Rajlich",
43 + "email": "nathan@tootallnate.net",
44 + "url": "http://n8.io"
45 + },
46 + {
47 + "name": "Andrew Rhyne",
48 + "email": "rhyneandrew@gmail.com"
49 + }
50 + ],
51 + "dependencies": {
52 + "ms": "2.0.0"
53 + },
54 + "deprecated": false,
55 + "description": "small debugging utility",
56 + "devDependencies": {
57 + "browserify": "9.0.3",
58 + "chai": "^3.5.0",
59 + "concurrently": "^3.1.0",
60 + "coveralls": "^2.11.15",
61 + "eslint": "^3.12.1",
62 + "istanbul": "^0.4.5",
63 + "karma": "^1.3.0",
64 + "karma-chai": "^0.1.0",
65 + "karma-mocha": "^1.3.0",
66 + "karma-phantomjs-launcher": "^1.0.2",
67 + "karma-sinon": "^1.0.5",
68 + "mocha": "^3.2.0",
69 + "mocha-lcov-reporter": "^1.2.0",
70 + "rimraf": "^2.5.4",
71 + "sinon": "^1.17.6",
72 + "sinon-chai": "^2.8.0"
73 + },
74 + "homepage": "https://github.com/visionmedia/debug#readme",
75 + "keywords": [
76 + "debug",
77 + "log",
78 + "debugger"
79 + ],
80 + "license": "MIT",
81 + "main": "./src/index.js",
82 + "name": "debug",
83 + "repository": {
84 + "type": "git",
85 + "url": "git://github.com/visionmedia/debug.git"
86 + },
87 + "version": "2.6.9"
88 +}
1 +/**
2 + * This is the web browser implementation of `debug()`.
3 + *
4 + * Expose `debug()` as the module.
5 + */
6 +
7 +exports = module.exports = require('./debug');
8 +exports.log = log;
9 +exports.formatArgs = formatArgs;
10 +exports.save = save;
11 +exports.load = load;
12 +exports.useColors = useColors;
13 +exports.storage = 'undefined' != typeof chrome
14 + && 'undefined' != typeof chrome.storage
15 + ? chrome.storage.local
16 + : localstorage();
17 +
18 +/**
19 + * Colors.
20 + */
21 +
22 +exports.colors = [
23 + 'lightseagreen',
24 + 'forestgreen',
25 + 'goldenrod',
26 + 'dodgerblue',
27 + 'darkorchid',
28 + 'crimson'
29 +];
30 +
31 +/**
32 + * Currently only WebKit-based Web Inspectors, Firefox >= v31,
33 + * and the Firebug extension (any Firefox version) are known
34 + * to support "%c" CSS customizations.
35 + *
36 + * TODO: add a `localStorage` variable to explicitly enable/disable colors
37 + */
38 +
39 +function useColors() {
40 + // NB: In an Electron preload script, document will be defined but not fully
41 + // initialized. Since we know we're in Chrome, we'll just detect this case
42 + // explicitly
43 + if (typeof window !== 'undefined' && window.process && window.process.type === 'renderer') {
44 + return true;
45 + }
46 +
47 + // is webkit? http://stackoverflow.com/a/16459606/376773
48 + // document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
49 + return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
50 + // is firebug? http://stackoverflow.com/a/398120/376773
51 + (typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
52 + // is firefox >= v31?
53 + // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
54 + (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) ||
55 + // double check webkit in userAgent just in case we are in a worker
56 + (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
57 +}
58 +
59 +/**
60 + * Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
61 + */
62 +
63 +exports.formatters.j = function(v) {
64 + try {
65 + return JSON.stringify(v);
66 + } catch (err) {
67 + return '[UnexpectedJSONParseError]: ' + err.message;
68 + }
69 +};
70 +
71 +
72 +/**
73 + * Colorize log arguments if enabled.
74 + *
75 + * @api public
76 + */
77 +
78 +function formatArgs(args) {
79 + var useColors = this.useColors;
80 +
81 + args[0] = (useColors ? '%c' : '')
82 + + this.namespace
83 + + (useColors ? ' %c' : ' ')
84 + + args[0]
85 + + (useColors ? '%c ' : ' ')
86 + + '+' + exports.humanize(this.diff);
87 +
88 + if (!useColors) return;
89 +
90 + var c = 'color: ' + this.color;
91 + args.splice(1, 0, c, 'color: inherit')
92 +
93 + // the final "%c" is somewhat tricky, because there could be other
94 + // arguments passed either before or after the %c, so we need to
95 + // figure out the correct index to insert the CSS into
96 + var index = 0;
97 + var lastC = 0;
98 + args[0].replace(/%[a-zA-Z%]/g, function(match) {
99 + if ('%%' === match) return;
100 + index++;
101 + if ('%c' === match) {
102 + // we only are interested in the *last* %c
103 + // (the user may have provided their own)
104 + lastC = index;
105 + }
106 + });
107 +
108 + args.splice(lastC, 0, c);
109 +}
110 +
111 +/**
112 + * Invokes `console.log()` when available.
113 + * No-op when `console.log` is not a "function".
114 + *
115 + * @api public
116 + */
117 +
118 +function log() {
119 + // this hackery is required for IE8/9, where
120 + // the `console.log` function doesn't have 'apply'
121 + return 'object' === typeof console
122 + && console.log
123 + && Function.prototype.apply.call(console.log, console, arguments);
124 +}
125 +
126 +/**
127 + * Save `namespaces`.
128 + *
129 + * @param {String} namespaces
130 + * @api private
131 + */
132 +
133 +function save(namespaces) {
134 + try {
135 + if (null == namespaces) {
136 + exports.storage.removeItem('debug');
137 + } else {
138 + exports.storage.debug = namespaces;
139 + }
140 + } catch(e) {}
141 +}
142 +
143 +/**
144 + * Load `namespaces`.
145 + *
146 + * @return {String} returns the previously persisted debug modes
147 + * @api private
148 + */
149 +
150 +function load() {
151 + var r;
152 + try {
153 + r = exports.storage.debug;
154 + } catch(e) {}
155 +
156 + // If debug isn't set in LS, and we're in Electron, try to load $DEBUG
157 + if (!r && typeof process !== 'undefined' && 'env' in process) {
158 + r = process.env.DEBUG;
159 + }
160 +
161 + return r;
162 +}
163 +
164 +/**
165 + * Enable namespaces listed in `localStorage.debug` initially.
166 + */
167 +
168 +exports.enable(load());
169 +
170 +/**
171 + * Localstorage attempts to return the localstorage.
172 + *
173 + * This is necessary because safari throws
174 + * when a user disables cookies/localstorage
175 + * and you attempt to access it.
176 + *
177 + * @return {LocalStorage}
178 + * @api private
179 + */
180 +
181 +function localstorage() {
182 + try {
183 + return window.localStorage;
184 + } catch (e) {}
185 +}
1 +
2 +/**
3 + * This is the common logic for both the Node.js and web browser
4 + * implementations of `debug()`.
5 + *
6 + * Expose `debug()` as the module.
7 + */
8 +
9 +exports = module.exports = createDebug.debug = createDebug['default'] = createDebug;
10 +exports.coerce = coerce;
11 +exports.disable = disable;
12 +exports.enable = enable;
13 +exports.enabled = enabled;
14 +exports.humanize = require('ms');
15 +
16 +/**
17 + * The currently active debug mode names, and names to skip.
18 + */
19 +
20 +exports.names = [];
21 +exports.skips = [];
22 +
23 +/**
24 + * Map of special "%n" handling functions, for the debug "format" argument.
25 + *
26 + * Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
27 + */
28 +
29 +exports.formatters = {};
30 +
31 +/**
32 + * Previous log timestamp.
33 + */
34 +
35 +var prevTime;
36 +
37 +/**
38 + * Select a color.
39 + * @param {String} namespace
40 + * @return {Number}
41 + * @api private
42 + */
43 +
44 +function selectColor(namespace) {
45 + var hash = 0, i;
46 +
47 + for (i in namespace) {
48 + hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
49 + hash |= 0; // Convert to 32bit integer
50 + }
51 +
52 + return exports.colors[Math.abs(hash) % exports.colors.length];
53 +}
54 +
55 +/**
56 + * Create a debugger with the given `namespace`.
57 + *
58 + * @param {String} namespace
59 + * @return {Function}
60 + * @api public
61 + */
62 +
63 +function createDebug(namespace) {
64 +
65 + function debug() {
66 + // disabled?
67 + if (!debug.enabled) return;
68 +
69 + var self = debug;
70 +
71 + // set `diff` timestamp
72 + var curr = +new Date();
73 + var ms = curr - (prevTime || curr);
74 + self.diff = ms;
75 + self.prev = prevTime;
76 + self.curr = curr;
77 + prevTime = curr;
78 +
79 + // turn the `arguments` into a proper Array
80 + var args = new Array(arguments.length);
81 + for (var i = 0; i < args.length; i++) {
82 + args[i] = arguments[i];
83 + }
84 +
85 + args[0] = exports.coerce(args[0]);
86 +
87 + if ('string' !== typeof args[0]) {
88 + // anything else let's inspect with %O
89 + args.unshift('%O');
90 + }
91 +
92 + // apply any `formatters` transformations
93 + var index = 0;
94 + args[0] = args[0].replace(/%([a-zA-Z%])/g, function(match, format) {
95 + // if we encounter an escaped % then don't increase the array index
96 + if (match === '%%') return match;
97 + index++;
98 + var formatter = exports.formatters[format];
99 + if ('function' === typeof formatter) {
100 + var val = args[index];
101 + match = formatter.call(self, val);
102 +
103 + // now we need to remove `args[index]` since it's inlined in the `format`
104 + args.splice(index, 1);
105 + index--;
106 + }
107 + return match;
108 + });
109 +
110 + // apply env-specific formatting (colors, etc.)
111 + exports.formatArgs.call(self, args);
112 +
113 + var logFn = debug.log || exports.log || console.log.bind(console);
114 + logFn.apply(self, args);
115 + }
116 +
117 + debug.namespace = namespace;
118 + debug.enabled = exports.enabled(namespace);
119 + debug.useColors = exports.useColors();
120 + debug.color = selectColor(namespace);
121 +
122 + // env-specific initialization logic for debug instances
123 + if ('function' === typeof exports.init) {
124 + exports.init(debug);
125 + }
126 +
127 + return debug;
128 +}
129 +
130 +/**
131 + * Enables a debug mode by namespaces. This can include modes
132 + * separated by a colon and wildcards.
133 + *
134 + * @param {String} namespaces
135 + * @api public
136 + */
137 +
138 +function enable(namespaces) {
139 + exports.save(namespaces);
140 +
141 + exports.names = [];
142 + exports.skips = [];
143 +
144 + var split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/);
145 + var len = split.length;
146 +
147 + for (var i = 0; i < len; i++) {
148 + if (!split[i]) continue; // ignore empty strings
149 + namespaces = split[i].replace(/\*/g, '.*?');
150 + if (namespaces[0] === '-') {
151 + exports.skips.push(new RegExp('^' + namespaces.substr(1) + '$'));
152 + } else {
153 + exports.names.push(new RegExp('^' + namespaces + '$'));
154 + }
155 + }
156 +}
157 +
158 +/**
159 + * Disable debug output.
160 + *
161 + * @api public
162 + */
163 +
164 +function disable() {
165 + exports.enable('');
166 +}
167 +
168 +/**
169 + * Returns true if the given mode name is enabled, false otherwise.
170 + *
171 + * @param {String} name
172 + * @return {Boolean}
173 + * @api public
174 + */
175 +
176 +function enabled(name) {
177 + var i, len;
178 + for (i = 0, len = exports.skips.length; i < len; i++) {
179 + if (exports.skips[i].test(name)) {
180 + return false;
181 + }
182 + }
183 + for (i = 0, len = exports.names.length; i < len; i++) {
184 + if (exports.names[i].test(name)) {
185 + return true;
186 + }
187 + }
188 + return false;
189 +}
190 +
191 +/**
192 + * Coerce `val`.
193 + *
194 + * @param {Mixed} val
195 + * @return {Mixed}
196 + * @api private
197 + */
198 +
199 +function coerce(val) {
200 + if (val instanceof Error) return val.stack || val.message;
201 + return val;
202 +}
1 +/**
2 + * Detect Electron renderer process, which is node, but we should
3 + * treat as a browser.
4 + */
5 +
6 +if (typeof process !== 'undefined' && process.type === 'renderer') {
7 + module.exports = require('./browser.js');
8 +} else {
9 + module.exports = require('./node.js');
10 +}
1 +module.exports = inspectorLog;
2 +
3 +// black hole
4 +const nullStream = new (require('stream').Writable)();
5 +nullStream._write = () => {};
6 +
7 +/**
8 + * Outputs a `console.log()` to the Node.js Inspector console *only*.
9 + */
10 +function inspectorLog() {
11 + const stdout = console._stdout;
12 + console._stdout = nullStream;
13 + console.log.apply(console, arguments);
14 + console._stdout = stdout;
15 +}
1 +/**
2 + * Module dependencies.
3 + */
4 +
5 +var tty = require('tty');
6 +var util = require('util');
7 +
8 +/**
9 + * This is the Node.js implementation of `debug()`.
10 + *
11 + * Expose `debug()` as the module.
12 + */
13 +
14 +exports = module.exports = require('./debug');
15 +exports.init = init;
16 +exports.log = log;
17 +exports.formatArgs = formatArgs;
18 +exports.save = save;
19 +exports.load = load;
20 +exports.useColors = useColors;
21 +
22 +/**
23 + * Colors.
24 + */
25 +
26 +exports.colors = [6, 2, 3, 4, 5, 1];
27 +
28 +/**
29 + * Build up the default `inspectOpts` object from the environment variables.
30 + *
31 + * $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
32 + */
33 +
34 +exports.inspectOpts = Object.keys(process.env).filter(function (key) {
35 + return /^debug_/i.test(key);
36 +}).reduce(function (obj, key) {
37 + // camel-case
38 + var prop = key
39 + .substring(6)
40 + .toLowerCase()
41 + .replace(/_([a-z])/g, function (_, k) { return k.toUpperCase() });
42 +
43 + // coerce string value into JS value
44 + var val = process.env[key];
45 + if (/^(yes|on|true|enabled)$/i.test(val)) val = true;
46 + else if (/^(no|off|false|disabled)$/i.test(val)) val = false;
47 + else if (val === 'null') val = null;
48 + else val = Number(val);
49 +
50 + obj[prop] = val;
51 + return obj;
52 +}, {});
53 +
54 +/**
55 + * The file descriptor to write the `debug()` calls to.
56 + * Set the `DEBUG_FD` env variable to override with another value. i.e.:
57 + *
58 + * $ DEBUG_FD=3 node script.js 3>debug.log
59 + */
60 +
61 +var fd = parseInt(process.env.DEBUG_FD, 10) || 2;
62 +
63 +if (1 !== fd && 2 !== fd) {
64 + util.deprecate(function(){}, 'except for stderr(2) and stdout(1), any other usage of DEBUG_FD is deprecated. Override debug.log if you want to use a different log function (https://git.io/debug_fd)')()
65 +}
66 +
67 +var stream = 1 === fd ? process.stdout :
68 + 2 === fd ? process.stderr :
69 + createWritableStdioStream(fd);
70 +
71 +/**
72 + * Is stdout a TTY? Colored output is enabled when `true`.
73 + */
74 +
75 +function useColors() {
76 + return 'colors' in exports.inspectOpts
77 + ? Boolean(exports.inspectOpts.colors)
78 + : tty.isatty(fd);
79 +}
80 +
81 +/**
82 + * Map %o to `util.inspect()`, all on a single line.
83 + */
84 +
85 +exports.formatters.o = function(v) {
86 + this.inspectOpts.colors = this.useColors;
87 + return util.inspect(v, this.inspectOpts)
88 + .split('\n').map(function(str) {
89 + return str.trim()
90 + }).join(' ');
91 +};
92 +
93 +/**
94 + * Map %o to `util.inspect()`, allowing multiple lines if needed.
95 + */
96 +
97 +exports.formatters.O = function(v) {
98 + this.inspectOpts.colors = this.useColors;
99 + return util.inspect(v, this.inspectOpts);
100 +};
101 +
102 +/**
103 + * Adds ANSI color escape codes if enabled.
104 + *
105 + * @api public
106 + */
107 +
108 +function formatArgs(args) {
109 + var name = this.namespace;
110 + var useColors = this.useColors;
111 +
112 + if (useColors) {
113 + var c = this.color;
114 + var prefix = ' \u001b[3' + c + ';1m' + name + ' ' + '\u001b[0m';
115 +
116 + args[0] = prefix + args[0].split('\n').join('\n' + prefix);
117 + args.push('\u001b[3' + c + 'm+' + exports.humanize(this.diff) + '\u001b[0m');
118 + } else {
119 + args[0] = new Date().toUTCString()
120 + + ' ' + name + ' ' + args[0];
121 + }
122 +}
123 +
124 +/**
125 + * Invokes `util.format()` with the specified arguments and writes to `stream`.
126 + */
127 +
128 +function log() {
129 + return stream.write(util.format.apply(util, arguments) + '\n');
130 +}
131 +
132 +/**
133 + * Save `namespaces`.
134 + *
135 + * @param {String} namespaces
136 + * @api private
137 + */
138 +
139 +function save(namespaces) {
140 + if (null == namespaces) {
141 + // If you set a process.env field to null or undefined, it gets cast to the
142 + // string 'null' or 'undefined'. Just delete instead.
143 + delete process.env.DEBUG;
144 + } else {
145 + process.env.DEBUG = namespaces;
146 + }
147 +}
148 +
149 +/**
150 + * Load `namespaces`.
151 + *
152 + * @return {String} returns the previously persisted debug modes
153 + * @api private
154 + */
155 +
156 +function load() {
157 + return process.env.DEBUG;
158 +}
159 +
160 +/**
161 + * Copied from `node/src/node.js`.
162 + *
163 + * XXX: It's lame that node doesn't expose this API out-of-the-box. It also
164 + * relies on the undocumented `tty_wrap.guessHandleType()` which is also lame.
165 + */
166 +
167 +function createWritableStdioStream (fd) {
168 + var stream;
169 + var tty_wrap = process.binding('tty_wrap');
170 +
171 + // Note stream._type is used for test-module-load-list.js
172 +
173 + switch (tty_wrap.guessHandleType(fd)) {
174 + case 'TTY':
175 + stream = new tty.WriteStream(fd);
176 + stream._type = 'tty';
177 +
178 + // Hack to have stream not keep the event loop alive.
179 + // See https://github.com/joyent/node/issues/1726
180 + if (stream._handle && stream._handle.unref) {
181 + stream._handle.unref();
182 + }
183 + break;
184 +
185 + case 'FILE':
186 + var fs = require('fs');
187 + stream = new fs.SyncWriteStream(fd, { autoClose: false });
188 + stream._type = 'fs';
189 + break;
190 +
191 + case 'PIPE':
192 + case 'TCP':
193 + var net = require('net');
194 + stream = new net.Socket({
195 + fd: fd,
196 + readable: false,
197 + writable: true
198 + });
199 +
200 + // FIXME Should probably have an option in net.Socket to create a
201 + // stream from an existing fd which is writable only. But for now
202 + // we'll just add this hack and set the `readable` member to false.
203 + // Test: ./node test/fixtures/echo.js < /etc/passwd
204 + stream.readable = false;
205 + stream.read = null;
206 + stream._type = 'pipe';
207 +
208 + // FIXME Hack to have stream not keep the event loop alive.
209 + // See https://github.com/joyent/node/issues/1726
210 + if (stream._handle && stream._handle.unref) {
211 + stream._handle.unref();
212 + }
213 + break;
214 +
215 + default:
216 + // Probably an error on in uv_guess_handle()
217 + throw new Error('Implement me. Unknown stream file type!');
218 + }
219 +
220 + // For supporting legacy API we put the FD here.
221 + stream.fd = fd;
222 +
223 + stream._isStdio = true;
224 +
225 + return stream;
226 +}
227 +
228 +/**
229 + * Init logic for `debug` instances.
230 + *
231 + * Create a new `inspectOpts` object in case `useColors` is set
232 + * differently for a particular `debug` instance.
233 + */
234 +
235 +function init (debug) {
236 + debug.inspectOpts = {};
237 +
238 + var keys = Object.keys(exports.inspectOpts);
239 + for (var i = 0; i < keys.length; i++) {
240 + debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
241 + }
242 +}
243 +
244 +/**
245 + * Enable namespaces listed in `process.env.DEBUG` initially.
246 + */
247 +
248 +exports.enable(load());
1 +1.1.2 / 2018-01-11
2 +==================
3 +
4 + * perf: remove argument reassignment
5 + * Support Node.js 0.6 to 9.x
6 +
7 +1.1.1 / 2017-07-27
8 +==================
9 +
10 + * Remove unnecessary `Buffer` loading
11 + * Support Node.js 0.6 to 8.x
12 +
13 +1.1.0 / 2015-09-14
14 +==================
15 +
16 + * Enable strict mode in more places
17 + * Support io.js 3.x
18 + * Support io.js 2.x
19 + * Support web browser loading
20 + - Requires bundler like Browserify or webpack
21 +
22 +1.0.1 / 2015-04-07
23 +==================
24 +
25 + * Fix `TypeError`s when under `'use strict'` code
26 + * Fix useless type name on auto-generated messages
27 + * Support io.js 1.x
28 + * Support Node.js 0.12
29 +
30 +1.0.0 / 2014-09-17
31 +==================
32 +
33 + * No changes
34 +
35 +0.4.5 / 2014-09-09
36 +==================
37 +
38 + * Improve call speed to functions using the function wrapper
39 + * Support Node.js 0.6
40 +
41 +0.4.4 / 2014-07-27
42 +==================
43 +
44 + * Work-around v8 generating empty stack traces
45 +
46 +0.4.3 / 2014-07-26
47 +==================
48 +
49 + * Fix exception when global `Error.stackTraceLimit` is too low
50 +
51 +0.4.2 / 2014-07-19
52 +==================
53 +
54 + * Correct call site for wrapped functions and properties
55 +
56 +0.4.1 / 2014-07-19
57 +==================
58 +
59 + * Improve automatic message generation for function properties
60 +
61 +0.4.0 / 2014-07-19
62 +==================
63 +
64 + * Add `TRACE_DEPRECATION` environment variable
65 + * Remove non-standard grey color from color output
66 + * Support `--no-deprecation` argument
67 + * Support `--trace-deprecation` argument
68 + * Support `deprecate.property(fn, prop, message)`
69 +
70 +0.3.0 / 2014-06-16
71 +==================
72 +
73 + * Add `NO_DEPRECATION` environment variable
74 +
75 +0.2.0 / 2014-06-15
76 +==================
77 +
78 + * Add `deprecate.property(obj, prop, message)`
79 + * Remove `supports-color` dependency for node.js 0.8
80 +
81 +0.1.0 / 2014-06-15
82 +==================
83 +
84 + * Add `deprecate.function(fn, message)`
85 + * Add `process.on('deprecation', fn)` emitter
86 + * Automatically generate message when omitted from `deprecate()`
87 +
88 +0.0.1 / 2014-06-15
89 +==================
90 +
91 + * Fix warning for dynamic calls at singe call site
92 +
93 +0.0.0 / 2014-06-15
94 +==================
95 +
96 + * Initial implementation
1 +(The MIT License)
2 +
3 +Copyright (c) 2014-2017 Douglas Christopher Wilson
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining
6 +a copy of this software and associated documentation files (the
7 +'Software'), to deal in the Software without restriction, including
8 +without limitation the rights to use, copy, modify, merge, publish,
9 +distribute, sublicense, and/or sell copies of the Software, and to
10 +permit persons to whom the Software is furnished to do so, subject to
11 +the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be
14 +included in all copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# depd
2 +
3 +[![NPM Version][npm-version-image]][npm-url]
4 +[![NPM Downloads][npm-downloads-image]][npm-url]
5 +[![Node.js Version][node-image]][node-url]
6 +[![Linux Build][travis-image]][travis-url]
7 +[![Windows Build][appveyor-image]][appveyor-url]
8 +[![Coverage Status][coveralls-image]][coveralls-url]
9 +
10 +Deprecate all the things
11 +
12 +> With great modules comes great responsibility; mark things deprecated!
13 +
14 +## Install
15 +
16 +This module is installed directly using `npm`:
17 +
18 +```sh
19 +$ npm install depd
20 +```
21 +
22 +This module can also be bundled with systems like
23 +[Browserify](http://browserify.org/) or [webpack](https://webpack.github.io/),
24 +though by default this module will alter it's API to no longer display or
25 +track deprecations.
26 +
27 +## API
28 +
29 +<!-- eslint-disable no-unused-vars -->
30 +
31 +```js
32 +var deprecate = require('depd')('my-module')
33 +```
34 +
35 +This library allows you to display deprecation messages to your users.
36 +This library goes above and beyond with deprecation warnings by
37 +introspection of the call stack (but only the bits that it is interested
38 +in).
39 +
40 +Instead of just warning on the first invocation of a deprecated
41 +function and never again, this module will warn on the first invocation
42 +of a deprecated function per unique call site, making it ideal to alert
43 +users of all deprecated uses across the code base, rather than just
44 +whatever happens to execute first.
45 +
46 +The deprecation warnings from this module also include the file and line
47 +information for the call into the module that the deprecated function was
48 +in.
49 +
50 +**NOTE** this library has a similar interface to the `debug` module, and
51 +this module uses the calling file to get the boundary for the call stacks,
52 +so you should always create a new `deprecate` object in each file and not
53 +within some central file.
54 +
55 +### depd(namespace)
56 +
57 +Create a new deprecate function that uses the given namespace name in the
58 +messages and will display the call site prior to the stack entering the
59 +file this function was called from. It is highly suggested you use the
60 +name of your module as the namespace.
61 +
62 +### deprecate(message)
63 +
64 +Call this function from deprecated code to display a deprecation message.
65 +This message will appear once per unique caller site. Caller site is the
66 +first call site in the stack in a different file from the caller of this
67 +function.
68 +
69 +If the message is omitted, a message is generated for you based on the site
70 +of the `deprecate()` call and will display the name of the function called,
71 +similar to the name displayed in a stack trace.
72 +
73 +### deprecate.function(fn, message)
74 +
75 +Call this function to wrap a given function in a deprecation message on any
76 +call to the function. An optional message can be supplied to provide a custom
77 +message.
78 +
79 +### deprecate.property(obj, prop, message)
80 +
81 +Call this function to wrap a given property on object in a deprecation message
82 +on any accessing or setting of the property. An optional message can be supplied
83 +to provide a custom message.
84 +
85 +The method must be called on the object where the property belongs (not
86 +inherited from the prototype).
87 +
88 +If the property is a data descriptor, it will be converted to an accessor
89 +descriptor in order to display the deprecation message.
90 +
91 +### process.on('deprecation', fn)
92 +
93 +This module will allow easy capturing of deprecation errors by emitting the
94 +errors as the type "deprecation" on the global `process`. If there are no
95 +listeners for this type, the errors are written to STDERR as normal, but if
96 +there are any listeners, nothing will be written to STDERR and instead only
97 +emitted. From there, you can write the errors in a different format or to a
98 +logging source.
99 +
100 +The error represents the deprecation and is emitted only once with the same
101 +rules as writing to STDERR. The error has the following properties:
102 +
103 + - `message` - This is the message given by the library
104 + - `name` - This is always `'DeprecationError'`
105 + - `namespace` - This is the namespace the deprecation came from
106 + - `stack` - This is the stack of the call to the deprecated thing
107 +
108 +Example `error.stack` output:
109 +
110 +```
111 +DeprecationError: my-cool-module deprecated oldfunction
112 + at Object.<anonymous> ([eval]-wrapper:6:22)
113 + at Module._compile (module.js:456:26)
114 + at evalScript (node.js:532:25)
115 + at startup (node.js:80:7)
116 + at node.js:902:3
117 +```
118 +
119 +### process.env.NO_DEPRECATION
120 +
121 +As a user of modules that are deprecated, the environment variable `NO_DEPRECATION`
122 +is provided as a quick solution to silencing deprecation warnings from being
123 +output. The format of this is similar to that of `DEBUG`:
124 +
125 +```sh
126 +$ NO_DEPRECATION=my-module,othermod node app.js
127 +```
128 +
129 +This will suppress deprecations from being output for "my-module" and "othermod".
130 +The value is a list of comma-separated namespaces. To suppress every warning
131 +across all namespaces, use the value `*` for a namespace.
132 +
133 +Providing the argument `--no-deprecation` to the `node` executable will suppress
134 +all deprecations (only available in Node.js 0.8 or higher).
135 +
136 +**NOTE** This will not suppress the deperecations given to any "deprecation"
137 +event listeners, just the output to STDERR.
138 +
139 +### process.env.TRACE_DEPRECATION
140 +
141 +As a user of modules that are deprecated, the environment variable `TRACE_DEPRECATION`
142 +is provided as a solution to getting more detailed location information in deprecation
143 +warnings by including the entire stack trace. The format of this is the same as
144 +`NO_DEPRECATION`:
145 +
146 +```sh
147 +$ TRACE_DEPRECATION=my-module,othermod node app.js
148 +```
149 +
150 +This will include stack traces for deprecations being output for "my-module" and
151 +"othermod". The value is a list of comma-separated namespaces. To trace every
152 +warning across all namespaces, use the value `*` for a namespace.
153 +
154 +Providing the argument `--trace-deprecation` to the `node` executable will trace
155 +all deprecations (only available in Node.js 0.8 or higher).
156 +
157 +**NOTE** This will not trace the deperecations silenced by `NO_DEPRECATION`.
158 +
159 +## Display
160 +
161 +![message](files/message.png)
162 +
163 +When a user calls a function in your library that you mark deprecated, they
164 +will see the following written to STDERR (in the given colors, similar colors
165 +and layout to the `debug` module):
166 +
167 +```
168 +bright cyan bright yellow
169 +| | reset cyan
170 +| | | |
171 +▼ ▼ ▼ ▼
172 +my-cool-module deprecated oldfunction [eval]-wrapper:6:22
173 +▲ ▲ ▲ ▲
174 +| | | |
175 +namespace | | location of mycoolmod.oldfunction() call
176 + | deprecation message
177 + the word "deprecated"
178 +```
179 +
180 +If the user redirects their STDERR to a file or somewhere that does not support
181 +colors, they see (similar layout to the `debug` module):
182 +
183 +```
184 +Sun, 15 Jun 2014 05:21:37 GMT my-cool-module deprecated oldfunction at [eval]-wrapper:6:22
185 +▲ ▲ ▲ ▲ ▲
186 +| | | | |
187 +timestamp of message namespace | | location of mycoolmod.oldfunction() call
188 + | deprecation message
189 + the word "deprecated"
190 +```
191 +
192 +## Examples
193 +
194 +### Deprecating all calls to a function
195 +
196 +This will display a deprecated message about "oldfunction" being deprecated
197 +from "my-module" on STDERR.
198 +
199 +```js
200 +var deprecate = require('depd')('my-cool-module')
201 +
202 +// message automatically derived from function name
203 +// Object.oldfunction
204 +exports.oldfunction = deprecate.function(function oldfunction () {
205 + // all calls to function are deprecated
206 +})
207 +
208 +// specific message
209 +exports.oldfunction = deprecate.function(function () {
210 + // all calls to function are deprecated
211 +}, 'oldfunction')
212 +```
213 +
214 +### Conditionally deprecating a function call
215 +
216 +This will display a deprecated message about "weirdfunction" being deprecated
217 +from "my-module" on STDERR when called with less than 2 arguments.
218 +
219 +```js
220 +var deprecate = require('depd')('my-cool-module')
221 +
222 +exports.weirdfunction = function () {
223 + if (arguments.length < 2) {
224 + // calls with 0 or 1 args are deprecated
225 + deprecate('weirdfunction args < 2')
226 + }
227 +}
228 +```
229 +
230 +When calling `deprecate` as a function, the warning is counted per call site
231 +within your own module, so you can display different deprecations depending
232 +on different situations and the users will still get all the warnings:
233 +
234 +```js
235 +var deprecate = require('depd')('my-cool-module')
236 +
237 +exports.weirdfunction = function () {
238 + if (arguments.length < 2) {
239 + // calls with 0 or 1 args are deprecated
240 + deprecate('weirdfunction args < 2')
241 + } else if (typeof arguments[0] !== 'string') {
242 + // calls with non-string first argument are deprecated
243 + deprecate('weirdfunction non-string first arg')
244 + }
245 +}
246 +```
247 +
248 +### Deprecating property access
249 +
250 +This will display a deprecated message about "oldprop" being deprecated
251 +from "my-module" on STDERR when accessed. A deprecation will be displayed
252 +when setting the value and when getting the value.
253 +
254 +```js
255 +var deprecate = require('depd')('my-cool-module')
256 +
257 +exports.oldprop = 'something'
258 +
259 +// message automatically derives from property name
260 +deprecate.property(exports, 'oldprop')
261 +
262 +// explicit message
263 +deprecate.property(exports, 'oldprop', 'oldprop >= 0.10')
264 +```
265 +
266 +## License
267 +
268 +[MIT](LICENSE)
269 +
270 +[npm-version-image]: https://img.shields.io/npm/v/depd.svg
271 +[npm-downloads-image]: https://img.shields.io/npm/dm/depd.svg
272 +[npm-url]: https://npmjs.org/package/depd
273 +[travis-image]: https://img.shields.io/travis/dougwilson/nodejs-depd/master.svg?label=linux
274 +[travis-url]: https://travis-ci.org/dougwilson/nodejs-depd
275 +[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/nodejs-depd/master.svg?label=windows
276 +[appveyor-url]: https://ci.appveyor.com/project/dougwilson/nodejs-depd
277 +[coveralls-image]: https://img.shields.io/coveralls/dougwilson/nodejs-depd/master.svg
278 +[coveralls-url]: https://coveralls.io/r/dougwilson/nodejs-depd?branch=master
279 +[node-image]: https://img.shields.io/node/v/depd.svg
280 +[node-url]: https://nodejs.org/en/download/
This diff is collapsed. Click to expand it.
1 +/*!
2 + * depd
3 + * Copyright(c) 2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module exports.
11 + * @public
12 + */
13 +
14 +module.exports = depd
15 +
16 +/**
17 + * Create deprecate for namespace in caller.
18 + */
19 +
20 +function depd (namespace) {
21 + if (!namespace) {
22 + throw new TypeError('argument namespace is required')
23 + }
24 +
25 + function deprecate (message) {
26 + // no-op in browser
27 + }
28 +
29 + deprecate._file = undefined
30 + deprecate._ignored = true
31 + deprecate._namespace = namespace
32 + deprecate._traced = false
33 + deprecate._warned = Object.create(null)
34 +
35 + deprecate.function = wrapfunction
36 + deprecate.property = wrapproperty
37 +
38 + return deprecate
39 +}
40 +
41 +/**
42 + * Return a wrapped function in a deprecation message.
43 + *
44 + * This is a no-op version of the wrapper, which does nothing but call
45 + * validation.
46 + */
47 +
48 +function wrapfunction (fn, message) {
49 + if (typeof fn !== 'function') {
50 + throw new TypeError('argument fn must be a function')
51 + }
52 +
53 + return fn
54 +}
55 +
56 +/**
57 + * Wrap property in a deprecation message.
58 + *
59 + * This is a no-op version of the wrapper, which does nothing but call
60 + * validation.
61 + */
62 +
63 +function wrapproperty (obj, prop, message) {
64 + if (!obj || (typeof obj !== 'object' && typeof obj !== 'function')) {
65 + throw new TypeError('argument obj must be object')
66 + }
67 +
68 + var descriptor = Object.getOwnPropertyDescriptor(obj, prop)
69 +
70 + if (!descriptor) {
71 + throw new TypeError('must call property on owner object')
72 + }
73 +
74 + if (!descriptor.configurable) {
75 + throw new TypeError('property must be configurable')
76 + }
77 +}
1 +/*!
2 + * depd
3 + * Copyright(c) 2014 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module exports.
11 + */
12 +
13 +module.exports = callSiteToString
14 +
15 +/**
16 + * Format a CallSite file location to a string.
17 + */
18 +
19 +function callSiteFileLocation (callSite) {
20 + var fileName
21 + var fileLocation = ''
22 +
23 + if (callSite.isNative()) {
24 + fileLocation = 'native'
25 + } else if (callSite.isEval()) {
26 + fileName = callSite.getScriptNameOrSourceURL()
27 + if (!fileName) {
28 + fileLocation = callSite.getEvalOrigin()
29 + }
30 + } else {
31 + fileName = callSite.getFileName()
32 + }
33 +
34 + if (fileName) {
35 + fileLocation += fileName
36 +
37 + var lineNumber = callSite.getLineNumber()
38 + if (lineNumber != null) {
39 + fileLocation += ':' + lineNumber
40 +
41 + var columnNumber = callSite.getColumnNumber()
42 + if (columnNumber) {
43 + fileLocation += ':' + columnNumber
44 + }
45 + }
46 + }
47 +
48 + return fileLocation || 'unknown source'
49 +}
50 +
51 +/**
52 + * Format a CallSite to a string.
53 + */
54 +
55 +function callSiteToString (callSite) {
56 + var addSuffix = true
57 + var fileLocation = callSiteFileLocation(callSite)
58 + var functionName = callSite.getFunctionName()
59 + var isConstructor = callSite.isConstructor()
60 + var isMethodCall = !(callSite.isToplevel() || isConstructor)
61 + var line = ''
62 +
63 + if (isMethodCall) {
64 + var methodName = callSite.getMethodName()
65 + var typeName = getConstructorName(callSite)
66 +
67 + if (functionName) {
68 + if (typeName && functionName.indexOf(typeName) !== 0) {
69 + line += typeName + '.'
70 + }
71 +
72 + line += functionName
73 +
74 + if (methodName && functionName.lastIndexOf('.' + methodName) !== functionName.length - methodName.length - 1) {
75 + line += ' [as ' + methodName + ']'
76 + }
77 + } else {
78 + line += typeName + '.' + (methodName || '<anonymous>')
79 + }
80 + } else if (isConstructor) {
81 + line += 'new ' + (functionName || '<anonymous>')
82 + } else if (functionName) {
83 + line += functionName
84 + } else {
85 + addSuffix = false
86 + line += fileLocation
87 + }
88 +
89 + if (addSuffix) {
90 + line += ' (' + fileLocation + ')'
91 + }
92 +
93 + return line
94 +}
95 +
96 +/**
97 + * Get constructor name of reviver.
98 + */
99 +
100 +function getConstructorName (obj) {
101 + var receiver = obj.receiver
102 + return (receiver.constructor && receiver.constructor.name) || null
103 +}
1 +/*!
2 + * depd
3 + * Copyright(c) 2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module exports.
11 + * @public
12 + */
13 +
14 +module.exports = eventListenerCount
15 +
16 +/**
17 + * Get the count of listeners on an event emitter of a specific type.
18 + */
19 +
20 +function eventListenerCount (emitter, type) {
21 + return emitter.listeners(type).length
22 +}
1 +/*!
2 + * depd
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + * @private
12 + */
13 +
14 +var EventEmitter = require('events').EventEmitter
15 +
16 +/**
17 + * Module exports.
18 + * @public
19 + */
20 +
21 +lazyProperty(module.exports, 'callSiteToString', function callSiteToString () {
22 + var limit = Error.stackTraceLimit
23 + var obj = {}
24 + var prep = Error.prepareStackTrace
25 +
26 + function prepareObjectStackTrace (obj, stack) {
27 + return stack
28 + }
29 +
30 + Error.prepareStackTrace = prepareObjectStackTrace
31 + Error.stackTraceLimit = 2
32 +
33 + // capture the stack
34 + Error.captureStackTrace(obj)
35 +
36 + // slice the stack
37 + var stack = obj.stack.slice()
38 +
39 + Error.prepareStackTrace = prep
40 + Error.stackTraceLimit = limit
41 +
42 + return stack[0].toString ? toString : require('./callsite-tostring')
43 +})
44 +
45 +lazyProperty(module.exports, 'eventListenerCount', function eventListenerCount () {
46 + return EventEmitter.listenerCount || require('./event-listener-count')
47 +})
48 +
49 +/**
50 + * Define a lazy property.
51 + */
52 +
53 +function lazyProperty (obj, prop, getter) {
54 + function get () {
55 + var val = getter()
56 +
57 + Object.defineProperty(obj, prop, {
58 + configurable: true,
59 + enumerable: true,
60 + value: val
61 + })
62 +
63 + return val
64 + }
65 +
66 + Object.defineProperty(obj, prop, {
67 + configurable: true,
68 + enumerable: true,
69 + get: get
70 + })
71 +}
72 +
73 +/**
74 + * Call toString() on the obj
75 + */
76 +
77 +function toString (obj) {
78 + return obj.toString()
79 +}
1 +{
2 + "_from": "depd@~1.1.2",
3 + "_id": "depd@1.1.2",
4 + "_inBundle": false,
5 + "_integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=",
6 + "_location": "/depd",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "range",
10 + "registry": true,
11 + "raw": "depd@~1.1.2",
12 + "name": "depd",
13 + "escapedName": "depd",
14 + "rawSpec": "~1.1.2",
15 + "saveSpec": null,
16 + "fetchSpec": "~1.1.2"
17 + },
18 + "_requiredBy": [
19 + "/body-parser",
20 + "/http-errors"
21 + ],
22 + "_resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz",
23 + "_shasum": "9bcd52e14c097763e749b274c4346ed2e560b5a9",
24 + "_spec": "depd@~1.1.2",
25 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/body-parser",
26 + "author": {
27 + "name": "Douglas Christopher Wilson",
28 + "email": "doug@somethingdoug.com"
29 + },
30 + "browser": "lib/browser/index.js",
31 + "bugs": {
32 + "url": "https://github.com/dougwilson/nodejs-depd/issues"
33 + },
34 + "bundleDependencies": false,
35 + "deprecated": false,
36 + "description": "Deprecate all the things",
37 + "devDependencies": {
38 + "beautify-benchmark": "0.2.4",
39 + "benchmark": "2.1.4",
40 + "eslint": "3.19.0",
41 + "eslint-config-standard": "7.1.0",
42 + "eslint-plugin-markdown": "1.0.0-beta.7",
43 + "eslint-plugin-promise": "3.6.0",
44 + "eslint-plugin-standard": "3.0.1",
45 + "istanbul": "0.4.5",
46 + "mocha": "~1.21.5"
47 + },
48 + "engines": {
49 + "node": ">= 0.6"
50 + },
51 + "files": [
52 + "lib/",
53 + "History.md",
54 + "LICENSE",
55 + "index.js",
56 + "Readme.md"
57 + ],
58 + "homepage": "https://github.com/dougwilson/nodejs-depd#readme",
59 + "keywords": [
60 + "deprecate",
61 + "deprecated"
62 + ],
63 + "license": "MIT",
64 + "name": "depd",
65 + "repository": {
66 + "type": "git",
67 + "url": "git+https://github.com/dougwilson/nodejs-depd.git"
68 + },
69 + "scripts": {
70 + "bench": "node benchmark/index.js",
71 + "lint": "eslint --plugin markdown --ext js,md .",
72 + "test": "mocha --reporter spec --bail test/",
73 + "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --no-exit test/",
74 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot test/"
75 + },
76 + "version": "1.1.2"
77 +}
1 +
2 +The MIT License (MIT)
3 +
4 +Copyright (c) 2014 Jonathan Ong me@jongleberry.com
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining a copy
7 +of this software and associated documentation files (the "Software"), to deal
8 +in the Software without restriction, including without limitation the rights
9 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 +copies of the Software, and to permit persons to whom the Software is
11 +furnished to do so, subject to the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be included in
14 +all copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 +THE SOFTWARE.
1 +# EE First
2 +
3 +[![NPM version][npm-image]][npm-url]
4 +[![Build status][travis-image]][travis-url]
5 +[![Test coverage][coveralls-image]][coveralls-url]
6 +[![License][license-image]][license-url]
7 +[![Downloads][downloads-image]][downloads-url]
8 +[![Gittip][gittip-image]][gittip-url]
9 +
10 +Get the first event in a set of event emitters and event pairs,
11 +then clean up after itself.
12 +
13 +## Install
14 +
15 +```sh
16 +$ npm install ee-first
17 +```
18 +
19 +## API
20 +
21 +```js
22 +var first = require('ee-first')
23 +```
24 +
25 +### first(arr, listener)
26 +
27 +Invoke `listener` on the first event from the list specified in `arr`. `arr` is
28 +an array of arrays, with each array in the format `[ee, ...event]`. `listener`
29 +will be called only once, the first time any of the given events are emitted. If
30 +`error` is one of the listened events, then if that fires first, the `listener`
31 +will be given the `err` argument.
32 +
33 +The `listener` is invoked as `listener(err, ee, event, args)`, where `err` is the
34 +first argument emitted from an `error` event, if applicable; `ee` is the event
35 +emitter that fired; `event` is the string event name that fired; and `args` is an
36 +array of the arguments that were emitted on the event.
37 +
38 +```js
39 +var ee1 = new EventEmitter()
40 +var ee2 = new EventEmitter()
41 +
42 +first([
43 + [ee1, 'close', 'end', 'error'],
44 + [ee2, 'error']
45 +], function (err, ee, event, args) {
46 + // listener invoked
47 +})
48 +```
49 +
50 +#### .cancel()
51 +
52 +The group of listeners can be cancelled before being invoked and have all the event
53 +listeners removed from the underlying event emitters.
54 +
55 +```js
56 +var thunk = first([
57 + [ee1, 'close', 'end', 'error'],
58 + [ee2, 'error']
59 +], function (err, ee, event, args) {
60 + // listener invoked
61 +})
62 +
63 +// cancel and clean up
64 +thunk.cancel()
65 +```
66 +
67 +[npm-image]: https://img.shields.io/npm/v/ee-first.svg?style=flat-square
68 +[npm-url]: https://npmjs.org/package/ee-first
69 +[github-tag]: http://img.shields.io/github/tag/jonathanong/ee-first.svg?style=flat-square
70 +[github-url]: https://github.com/jonathanong/ee-first/tags
71 +[travis-image]: https://img.shields.io/travis/jonathanong/ee-first.svg?style=flat-square
72 +[travis-url]: https://travis-ci.org/jonathanong/ee-first
73 +[coveralls-image]: https://img.shields.io/coveralls/jonathanong/ee-first.svg?style=flat-square
74 +[coveralls-url]: https://coveralls.io/r/jonathanong/ee-first?branch=master
75 +[license-image]: http://img.shields.io/npm/l/ee-first.svg?style=flat-square
76 +[license-url]: LICENSE.md
77 +[downloads-image]: http://img.shields.io/npm/dm/ee-first.svg?style=flat-square
78 +[downloads-url]: https://npmjs.org/package/ee-first
79 +[gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square
80 +[gittip-url]: https://www.gittip.com/jonathanong/
1 +/*!
2 + * ee-first
3 + * Copyright(c) 2014 Jonathan Ong
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module exports.
11 + * @public
12 + */
13 +
14 +module.exports = first
15 +
16 +/**
17 + * Get the first event in a set of event emitters and event pairs.
18 + *
19 + * @param {array} stuff
20 + * @param {function} done
21 + * @public
22 + */
23 +
24 +function first(stuff, done) {
25 + if (!Array.isArray(stuff))
26 + throw new TypeError('arg must be an array of [ee, events...] arrays')
27 +
28 + var cleanups = []
29 +
30 + for (var i = 0; i < stuff.length; i++) {
31 + var arr = stuff[i]
32 +
33 + if (!Array.isArray(arr) || arr.length < 2)
34 + throw new TypeError('each array member must be [ee, events...]')
35 +
36 + var ee = arr[0]
37 +
38 + for (var j = 1; j < arr.length; j++) {
39 + var event = arr[j]
40 + var fn = listener(event, callback)
41 +
42 + // listen to the event
43 + ee.on(event, fn)
44 + // push this listener to the list of cleanups
45 + cleanups.push({
46 + ee: ee,
47 + event: event,
48 + fn: fn,
49 + })
50 + }
51 + }
52 +
53 + function callback() {
54 + cleanup()
55 + done.apply(null, arguments)
56 + }
57 +
58 + function cleanup() {
59 + var x
60 + for (var i = 0; i < cleanups.length; i++) {
61 + x = cleanups[i]
62 + x.ee.removeListener(x.event, x.fn)
63 + }
64 + }
65 +
66 + function thunk(fn) {
67 + done = fn
68 + }
69 +
70 + thunk.cancel = cleanup
71 +
72 + return thunk
73 +}
74 +
75 +/**
76 + * Create the event listener.
77 + * @private
78 + */
79 +
80 +function listener(event, done) {
81 + return function onevent(arg1) {
82 + var args = new Array(arguments.length)
83 + var ee = this
84 + var err = event === 'error'
85 + ? arg1
86 + : null
87 +
88 + // copy args to prevent arguments escaping scope
89 + for (var i = 0; i < args.length; i++) {
90 + args[i] = arguments[i]
91 + }
92 +
93 + done(err, ee, event, args)
94 + }
95 +}
1 +{
2 + "_from": "ee-first@1.1.1",
3 + "_id": "ee-first@1.1.1",
4 + "_inBundle": false,
5 + "_integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=",
6 + "_location": "/ee-first",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "version",
10 + "registry": true,
11 + "raw": "ee-first@1.1.1",
12 + "name": "ee-first",
13 + "escapedName": "ee-first",
14 + "rawSpec": "1.1.1",
15 + "saveSpec": null,
16 + "fetchSpec": "1.1.1"
17 + },
18 + "_requiredBy": [
19 + "/on-finished"
20 + ],
21 + "_resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz",
22 + "_shasum": "590c61156b0ae2f4f0255732a158b266bc56b21d",
23 + "_spec": "ee-first@1.1.1",
24 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/on-finished",
25 + "author": {
26 + "name": "Jonathan Ong",
27 + "email": "me@jongleberry.com",
28 + "url": "http://jongleberry.com"
29 + },
30 + "bugs": {
31 + "url": "https://github.com/jonathanong/ee-first/issues"
32 + },
33 + "bundleDependencies": false,
34 + "contributors": [
35 + {
36 + "name": "Douglas Christopher Wilson",
37 + "email": "doug@somethingdoug.com"
38 + }
39 + ],
40 + "deprecated": false,
41 + "description": "return the first event in a set of ee/event pairs",
42 + "devDependencies": {
43 + "istanbul": "0.3.9",
44 + "mocha": "2.2.5"
45 + },
46 + "files": [
47 + "index.js",
48 + "LICENSE"
49 + ],
50 + "homepage": "https://github.com/jonathanong/ee-first#readme",
51 + "license": "MIT",
52 + "name": "ee-first",
53 + "repository": {
54 + "type": "git",
55 + "url": "git+https://github.com/jonathanong/ee-first.git"
56 + },
57 + "scripts": {
58 + "test": "mocha --reporter spec --bail --check-leaks test/",
59 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
60 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/"
61 + },
62 + "version": "1.1.1"
63 +}
1 +2019-02-18 / 1.7.2
2 +==================
3 +
4 + * deps: setprototypeof@1.1.1
5 +
6 +2018-09-08 / 1.7.1
7 +==================
8 +
9 + * Fix error creating objects in some environments
10 +
11 +2018-07-30 / 1.7.0
12 +==================
13 +
14 + * Set constructor name when possible
15 + * Use `toidentifier` module to make class names
16 + * deps: statuses@'>= 1.5.0 < 2'
17 +
18 +2018-03-29 / 1.6.3
19 +==================
20 +
21 + * deps: depd@~1.1.2
22 + - perf: remove argument reassignment
23 + * deps: setprototypeof@1.1.0
24 + * deps: statuses@'>= 1.4.0 < 2'
25 +
26 +2017-08-04 / 1.6.2
27 +==================
28 +
29 + * deps: depd@1.1.1
30 + - Remove unnecessary `Buffer` loading
31 +
32 +2017-02-20 / 1.6.1
33 +==================
34 +
35 + * deps: setprototypeof@1.0.3
36 + - Fix shim for old browsers
37 +
38 +2017-02-14 / 1.6.0
39 +==================
40 +
41 + * Accept custom 4xx and 5xx status codes in factory
42 + * Add deprecation message to `"I'mateapot"` export
43 + * Deprecate passing status code as anything except first argument in factory
44 + * Deprecate using non-error status codes
45 + * Make `message` property enumerable for `HttpError`s
46 +
47 +2016-11-16 / 1.5.1
48 +==================
49 +
50 + * deps: inherits@2.0.3
51 + - Fix issue loading in browser
52 + * deps: setprototypeof@1.0.2
53 + * deps: statuses@'>= 1.3.1 < 2'
54 +
55 +2016-05-18 / 1.5.0
56 +==================
57 +
58 + * Support new code `421 Misdirected Request`
59 + * Use `setprototypeof` module to replace `__proto__` setting
60 + * deps: statuses@'>= 1.3.0 < 2'
61 + - Add `421 Misdirected Request`
62 + - perf: enable strict mode
63 + * perf: enable strict mode
64 +
65 +2016-01-28 / 1.4.0
66 +==================
67 +
68 + * Add `HttpError` export, for `err instanceof createError.HttpError`
69 + * deps: inherits@2.0.1
70 + * deps: statuses@'>= 1.2.1 < 2'
71 + - Fix message for status 451
72 + - Remove incorrect nginx status code
73 +
74 +2015-02-02 / 1.3.1
75 +==================
76 +
77 + * Fix regression where status can be overwritten in `createError` `props`
78 +
79 +2015-02-01 / 1.3.0
80 +==================
81 +
82 + * Construct errors using defined constructors from `createError`
83 + * Fix error names that are not identifiers
84 + - `createError["I'mateapot"]` is now `createError.ImATeapot`
85 + * Set a meaningful `name` property on constructed errors
86 +
87 +2014-12-09 / 1.2.8
88 +==================
89 +
90 + * Fix stack trace from exported function
91 + * Remove `arguments.callee` usage
92 +
93 +2014-10-14 / 1.2.7
94 +==================
95 +
96 + * Remove duplicate line
97 +
98 +2014-10-02 / 1.2.6
99 +==================
100 +
101 + * Fix `expose` to be `true` for `ClientError` constructor
102 +
103 +2014-09-28 / 1.2.5
104 +==================
105 +
106 + * deps: statuses@1
107 +
108 +2014-09-21 / 1.2.4
109 +==================
110 +
111 + * Fix dependency version to work with old `npm`s
112 +
113 +2014-09-21 / 1.2.3
114 +==================
115 +
116 + * deps: statuses@~1.1.0
117 +
118 +2014-09-21 / 1.2.2
119 +==================
120 +
121 + * Fix publish error
122 +
123 +2014-09-21 / 1.2.1
124 +==================
125 +
126 + * Support Node.js 0.6
127 + * Use `inherits` instead of `util`
128 +
129 +2014-09-09 / 1.2.0
130 +==================
131 +
132 + * Fix the way inheriting functions
133 + * Support `expose` being provided in properties argument
134 +
135 +2014-09-08 / 1.1.0
136 +==================
137 +
138 + * Default status to 500
139 + * Support provided `error` to extend
140 +
141 +2014-09-08 / 1.0.1
142 +==================
143 +
144 + * Fix accepting string message
145 +
146 +2014-09-08 / 1.0.0
147 +==================
148 +
149 + * Initial release
1 +
2 +The MIT License (MIT)
3 +
4 +Copyright (c) 2014 Jonathan Ong me@jongleberry.com
5 +Copyright (c) 2016 Douglas Christopher Wilson doug@somethingdoug.com
6 +
7 +Permission is hereby granted, free of charge, to any person obtaining a copy
8 +of this software and associated documentation files (the "Software"), to deal
9 +in the Software without restriction, including without limitation the rights
10 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 +copies of the Software, and to permit persons to whom the Software is
12 +furnished to do so, subject to the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be included in
15 +all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 +THE SOFTWARE.
1 +# http-errors
2 +
3 +[![NPM Version][npm-version-image]][npm-url]
4 +[![NPM Downloads][npm-downloads-image]][node-url]
5 +[![Node.js Version][node-image]][node-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Create HTTP errors for Express, Koa, Connect, etc. with ease.
10 +
11 +## Install
12 +
13 +This is a [Node.js](https://nodejs.org/en/) module available through the
14 +[npm registry](https://www.npmjs.com/). Installation is done using the
15 +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
16 +
17 +```bash
18 +$ npm install http-errors
19 +```
20 +
21 +## Example
22 +
23 +```js
24 +var createError = require('http-errors')
25 +var express = require('express')
26 +var app = express()
27 +
28 +app.use(function (req, res, next) {
29 + if (!req.user) return next(createError(401, 'Please login to view this page.'))
30 + next()
31 +})
32 +```
33 +
34 +## API
35 +
36 +This is the current API, currently extracted from Koa and subject to change.
37 +
38 +### Error Properties
39 +
40 +- `expose` - can be used to signal if `message` should be sent to the client,
41 + defaulting to `false` when `status` >= 500
42 +- `headers` - can be an object of header names to values to be sent to the
43 + client, defaulting to `undefined`. When defined, the key names should all
44 + be lower-cased
45 +- `message` - the traditional error message, which should be kept short and all
46 + single line
47 +- `status` - the status code of the error, mirroring `statusCode` for general
48 + compatibility
49 +- `statusCode` - the status code of the error, defaulting to `500`
50 +
51 +### createError([status], [message], [properties])
52 +
53 +Create a new error object with the given message `msg`.
54 +The error object inherits from `createError.HttpError`.
55 +
56 +<!-- eslint-disable no-undef, no-unused-vars -->
57 +
58 +```js
59 +var err = createError(404, 'This video does not exist!')
60 +```
61 +
62 +- `status: 500` - the status code as a number
63 +- `message` - the message of the error, defaulting to node's text for that status code.
64 +- `properties` - custom properties to attach to the object
65 +
66 +### createError([status], [error], [properties])
67 +
68 +Extend the given `error` object with `createError.HttpError`
69 +properties. This will not alter the inheritance of the given
70 +`error` object, and the modified `error` object is the
71 +return value.
72 +
73 +<!-- eslint-disable no-redeclare, no-undef, no-unused-vars -->
74 +
75 +```js
76 +fs.readFile('foo.txt', function (err, buf) {
77 + if (err) {
78 + if (err.code === 'ENOENT') {
79 + var httpError = createError(404, err, { expose: false })
80 + } else {
81 + var httpError = createError(500, err)
82 + }
83 + }
84 +})
85 +```
86 +
87 +- `status` - the status code as a number
88 +- `error` - the error object to extend
89 +- `properties` - custom properties to attach to the object
90 +
91 +### new createError\[code || name\](\[msg]\))
92 +
93 +Create a new error object with the given message `msg`.
94 +The error object inherits from `createError.HttpError`.
95 +
96 +<!-- eslint-disable no-undef, no-unused-vars -->
97 +
98 +```js
99 +var err = new createError.NotFound()
100 +```
101 +
102 +- `code` - the status code as a number
103 +- `name` - the name of the error as a "bumpy case", i.e. `NotFound` or `InternalServerError`.
104 +
105 +#### List of all constructors
106 +
107 +|Status Code|Constructor Name |
108 +|-----------|-----------------------------|
109 +|400 |BadRequest |
110 +|401 |Unauthorized |
111 +|402 |PaymentRequired |
112 +|403 |Forbidden |
113 +|404 |NotFound |
114 +|405 |MethodNotAllowed |
115 +|406 |NotAcceptable |
116 +|407 |ProxyAuthenticationRequired |
117 +|408 |RequestTimeout |
118 +|409 |Conflict |
119 +|410 |Gone |
120 +|411 |LengthRequired |
121 +|412 |PreconditionFailed |
122 +|413 |PayloadTooLarge |
123 +|414 |URITooLong |
124 +|415 |UnsupportedMediaType |
125 +|416 |RangeNotSatisfiable |
126 +|417 |ExpectationFailed |
127 +|418 |ImATeapot |
128 +|421 |MisdirectedRequest |
129 +|422 |UnprocessableEntity |
130 +|423 |Locked |
131 +|424 |FailedDependency |
132 +|425 |UnorderedCollection |
133 +|426 |UpgradeRequired |
134 +|428 |PreconditionRequired |
135 +|429 |TooManyRequests |
136 +|431 |RequestHeaderFieldsTooLarge |
137 +|451 |UnavailableForLegalReasons |
138 +|500 |InternalServerError |
139 +|501 |NotImplemented |
140 +|502 |BadGateway |
141 +|503 |ServiceUnavailable |
142 +|504 |GatewayTimeout |
143 +|505 |HTTPVersionNotSupported |
144 +|506 |VariantAlsoNegotiates |
145 +|507 |InsufficientStorage |
146 +|508 |LoopDetected |
147 +|509 |BandwidthLimitExceeded |
148 +|510 |NotExtended |
149 +|511 |NetworkAuthenticationRequired|
150 +
151 +## License
152 +
153 +[MIT](LICENSE)
154 +
155 +[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/http-errors/master
156 +[coveralls-url]: https://coveralls.io/r/jshttp/http-errors?branch=master
157 +[node-image]: https://badgen.net/npm/node/http-errors
158 +[node-url]: https://nodejs.org/en/download
159 +[npm-downloads-image]: https://badgen.net/npm/dm/http-errors
160 +[npm-url]: https://npmjs.org/package/http-errors
161 +[npm-version-image]: https://badgen.net/npm/v/http-errors
162 +[travis-image]: https://badgen.net/travis/jshttp/http-errors/master
163 +[travis-url]: https://travis-ci.org/jshttp/http-errors
1 +/*!
2 + * http-errors
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2016 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var deprecate = require('depd')('http-errors')
16 +var setPrototypeOf = require('setprototypeof')
17 +var statuses = require('statuses')
18 +var inherits = require('inherits')
19 +var toIdentifier = require('toidentifier')
20 +
21 +/**
22 + * Module exports.
23 + * @public
24 + */
25 +
26 +module.exports = createError
27 +module.exports.HttpError = createHttpErrorConstructor()
28 +
29 +// Populate exports for all constructors
30 +populateConstructorExports(module.exports, statuses.codes, module.exports.HttpError)
31 +
32 +/**
33 + * Get the code class of a status code.
34 + * @private
35 + */
36 +
37 +function codeClass (status) {
38 + return Number(String(status).charAt(0) + '00')
39 +}
40 +
41 +/**
42 + * Create a new HTTP Error.
43 + *
44 + * @returns {Error}
45 + * @public
46 + */
47 +
48 +function createError () {
49 + // so much arity going on ~_~
50 + var err
51 + var msg
52 + var status = 500
53 + var props = {}
54 + for (var i = 0; i < arguments.length; i++) {
55 + var arg = arguments[i]
56 + if (arg instanceof Error) {
57 + err = arg
58 + status = err.status || err.statusCode || status
59 + continue
60 + }
61 + switch (typeof arg) {
62 + case 'string':
63 + msg = arg
64 + break
65 + case 'number':
66 + status = arg
67 + if (i !== 0) {
68 + deprecate('non-first-argument status code; replace with createError(' + arg + ', ...)')
69 + }
70 + break
71 + case 'object':
72 + props = arg
73 + break
74 + }
75 + }
76 +
77 + if (typeof status === 'number' && (status < 400 || status >= 600)) {
78 + deprecate('non-error status code; use only 4xx or 5xx status codes')
79 + }
80 +
81 + if (typeof status !== 'number' ||
82 + (!statuses[status] && (status < 400 || status >= 600))) {
83 + status = 500
84 + }
85 +
86 + // constructor
87 + var HttpError = createError[status] || createError[codeClass(status)]
88 +
89 + if (!err) {
90 + // create error
91 + err = HttpError
92 + ? new HttpError(msg)
93 + : new Error(msg || statuses[status])
94 + Error.captureStackTrace(err, createError)
95 + }
96 +
97 + if (!HttpError || !(err instanceof HttpError) || err.status !== status) {
98 + // add properties to generic error
99 + err.expose = status < 500
100 + err.status = err.statusCode = status
101 + }
102 +
103 + for (var key in props) {
104 + if (key !== 'status' && key !== 'statusCode') {
105 + err[key] = props[key]
106 + }
107 + }
108 +
109 + return err
110 +}
111 +
112 +/**
113 + * Create HTTP error abstract base class.
114 + * @private
115 + */
116 +
117 +function createHttpErrorConstructor () {
118 + function HttpError () {
119 + throw new TypeError('cannot construct abstract class')
120 + }
121 +
122 + inherits(HttpError, Error)
123 +
124 + return HttpError
125 +}
126 +
127 +/**
128 + * Create a constructor for a client error.
129 + * @private
130 + */
131 +
132 +function createClientErrorConstructor (HttpError, name, code) {
133 + var className = name.match(/Error$/) ? name : name + 'Error'
134 +
135 + function ClientError (message) {
136 + // create the error object
137 + var msg = message != null ? message : statuses[code]
138 + var err = new Error(msg)
139 +
140 + // capture a stack trace to the construction point
141 + Error.captureStackTrace(err, ClientError)
142 +
143 + // adjust the [[Prototype]]
144 + setPrototypeOf(err, ClientError.prototype)
145 +
146 + // redefine the error message
147 + Object.defineProperty(err, 'message', {
148 + enumerable: true,
149 + configurable: true,
150 + value: msg,
151 + writable: true
152 + })
153 +
154 + // redefine the error name
155 + Object.defineProperty(err, 'name', {
156 + enumerable: false,
157 + configurable: true,
158 + value: className,
159 + writable: true
160 + })
161 +
162 + return err
163 + }
164 +
165 + inherits(ClientError, HttpError)
166 + nameFunc(ClientError, className)
167 +
168 + ClientError.prototype.status = code
169 + ClientError.prototype.statusCode = code
170 + ClientError.prototype.expose = true
171 +
172 + return ClientError
173 +}
174 +
175 +/**
176 + * Create a constructor for a server error.
177 + * @private
178 + */
179 +
180 +function createServerErrorConstructor (HttpError, name, code) {
181 + var className = name.match(/Error$/) ? name : name + 'Error'
182 +
183 + function ServerError (message) {
184 + // create the error object
185 + var msg = message != null ? message : statuses[code]
186 + var err = new Error(msg)
187 +
188 + // capture a stack trace to the construction point
189 + Error.captureStackTrace(err, ServerError)
190 +
191 + // adjust the [[Prototype]]
192 + setPrototypeOf(err, ServerError.prototype)
193 +
194 + // redefine the error message
195 + Object.defineProperty(err, 'message', {
196 + enumerable: true,
197 + configurable: true,
198 + value: msg,
199 + writable: true
200 + })
201 +
202 + // redefine the error name
203 + Object.defineProperty(err, 'name', {
204 + enumerable: false,
205 + configurable: true,
206 + value: className,
207 + writable: true
208 + })
209 +
210 + return err
211 + }
212 +
213 + inherits(ServerError, HttpError)
214 + nameFunc(ServerError, className)
215 +
216 + ServerError.prototype.status = code
217 + ServerError.prototype.statusCode = code
218 + ServerError.prototype.expose = false
219 +
220 + return ServerError
221 +}
222 +
223 +/**
224 + * Set the name of a function, if possible.
225 + * @private
226 + */
227 +
228 +function nameFunc (func, name) {
229 + var desc = Object.getOwnPropertyDescriptor(func, 'name')
230 +
231 + if (desc && desc.configurable) {
232 + desc.value = name
233 + Object.defineProperty(func, 'name', desc)
234 + }
235 +}
236 +
237 +/**
238 + * Populate the exports object with constructors for every error class.
239 + * @private
240 + */
241 +
242 +function populateConstructorExports (exports, codes, HttpError) {
243 + codes.forEach(function forEachCode (code) {
244 + var CodeError
245 + var name = toIdentifier(statuses[code])
246 +
247 + switch (codeClass(code)) {
248 + case 400:
249 + CodeError = createClientErrorConstructor(HttpError, name, code)
250 + break
251 + case 500:
252 + CodeError = createServerErrorConstructor(HttpError, name, code)
253 + break
254 + }
255 +
256 + if (CodeError) {
257 + // export the constructor
258 + exports[code] = CodeError
259 + exports[name] = CodeError
260 + }
261 + })
262 +
263 + // backwards-compatibility
264 + exports["I'mateapot"] = deprecate.function(exports.ImATeapot,
265 + '"I\'mateapot"; use "ImATeapot" instead')
266 +}
1 +{
2 + "_from": "http-errors@1.7.2",
3 + "_id": "http-errors@1.7.2",
4 + "_inBundle": false,
5 + "_integrity": "sha512-uUQBt3H/cSIVfch6i1EuPNy/YsRSOUBXTVfZ+yR7Zjez3qjBz6i9+i4zjNaoqcoFVI4lQJ5plg63TvGfRSDCRg==",
6 + "_location": "/http-errors",
7 + "_phantomChildren": {},
8 + "_requested": {
9 + "type": "version",
10 + "registry": true,
11 + "raw": "http-errors@1.7.2",
12 + "name": "http-errors",
13 + "escapedName": "http-errors",
14 + "rawSpec": "1.7.2",
15 + "saveSpec": null,
16 + "fetchSpec": "1.7.2"
17 + },
18 + "_requiredBy": [
19 + "/body-parser",
20 + "/raw-body"
21 + ],
22 + "_resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.7.2.tgz",
23 + "_shasum": "4f5029cf13239f31036e5b2e55292bcfbcc85c8f",
24 + "_spec": "http-errors@1.7.2",
25 + "_where": "/Users/mindyeoi/Desktop/We-Shop/node_modules/body-parser",
26 + "author": {
27 + "name": "Jonathan Ong",
28 + "email": "me@jongleberry.com",
29 + "url": "http://jongleberry.com"
30 + },
31 + "bugs": {
32 + "url": "https://github.com/jshttp/http-errors/issues"
33 + },
34 + "bundleDependencies": false,
35 + "contributors": [
36 + {
37 + "name": "Alan Plum",
38 + "email": "me@pluma.io"
39 + },
40 + {
41 + "name": "Douglas Christopher Wilson",
42 + "email": "doug@somethingdoug.com"
43 + }
44 + ],
45 + "dependencies": {
46 + "depd": "~1.1.2",
47 + "inherits": "2.0.3",
48 + "setprototypeof": "1.1.1",
49 + "statuses": ">= 1.5.0 < 2",
50 + "toidentifier": "1.0.0"
51 + },
52 + "deprecated": false,
53 + "description": "Create HTTP error objects",
54 + "devDependencies": {
55 + "eslint": "5.13.0",
56 + "eslint-config-standard": "12.0.0",
57 + "eslint-plugin-import": "2.16.0",
58 + "eslint-plugin-markdown": "1.0.0",
59 + "eslint-plugin-node": "7.0.1",
60 + "eslint-plugin-promise": "4.0.1",
61 + "eslint-plugin-standard": "4.0.0",
62 + "istanbul": "0.4.5",
63 + "mocha": "5.2.0"
64 + },
65 + "engines": {
66 + "node": ">= 0.6"
67 + },
68 + "files": [
69 + "index.js",
70 + "HISTORY.md",
71 + "LICENSE",
72 + "README.md"
73 + ],
74 + "homepage": "https://github.com/jshttp/http-errors#readme",
75 + "keywords": [
76 + "http",
77 + "error"
78 + ],
79 + "license": "MIT",
80 + "name": "http-errors",
81 + "repository": {
82 + "type": "git",
83 + "url": "git+https://github.com/jshttp/http-errors.git"
84 + },
85 + "scripts": {
86 + "lint": "eslint --plugin markdown --ext js,md . && node ./scripts/lint-readme-list.js",
87 + "test": "mocha --reporter spec --bail",
88 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot",
89 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter dot"
90 + },
91 + "version": "1.7.2"
92 +}
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff could not be displayed because it is too large.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.