v.1.0.0

Author: BridgeAR

.gitignore

@@ -0,0 +1,6 @@
+logs
+*.log
+coverage
+node_modules
+.idea
+.vscode

.npmignore

@@ -0,0 +1,15 @@
+# IntelliJ project files
+.idea
+*.iml
+out
+gen
+
+# Unrelevant files and folders
+benchmark
+coverage
+test
+.travis.yml
+.gitignore
+*.log
+.vscode
+.codeclimate.yml

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+sudo: false
+node_js:
+  - "4"
+  - "6"
+  - "7"
+install:
+  - npm install

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ruben Bridgewater
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,40 @@
+[![Build Status](https://travis-ci.org/NodeRedis/redis-errors.png?branch=master)](https://travis-ci.org/NodeRedis/redis-errors)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+# redis-errors
+
+All error classes used in [node_redis](https://github.com/NodeRedis/node_redis) are in here. They can be required as needed.
+
+## Install
+
+Install with [NPM](https://npmjs.org/):
+
+  npm install redis-errors
+
+## Usage
+
+```js
+const { RedisError, ReplyError } = require('redis-errors');
+
+// Using async await
+try {
+  return client.set('foo') // Missing value
+} catch (err) {
+  if (err instanceof ReplyError) {
+    console.log(err)
+  }
+  throw err
+}
+```
+
+### Error classes
+
+* `RedisError` sub class of Error
+* `ReplyError` sub class of RedisError
+* `ParserError` sub class of RedisError
+
+All Redis errors will be returned as `ReplyErrors` while a parser error is returned as `ParserError`.
+
+## License
+
+[MIT](./LICENSE)

index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./lib/errors')

lib/errors.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const assert = require('assert')
+
+class RedisError extends Error {
+  get name () {
+    return this.constructor.name
+  }
+}
+
+class ParserError extends RedisError {
+  constructor (message, buffer, offset) {
+    assert(buffer)
+    assert.strictEqual(typeof offset, 'number')
+
+    const tmp = Error.stackTraceLimit
+    Error.stackTraceLimit = 2
+    super(message)
+    Error.stackTraceLimit = tmp
+    this.offset = offset
+    this.buffer = buffer
+  }
+
+  get name () {
+    return this.constructor.name
+  }
+}
+
+class ReplyError extends RedisError {
+  constructor (message) {
+    const tmp = Error.stackTraceLimit
+    Error.stackTraceLimit = 2
+    super(message)
+    Error.stackTraceLimit = tmp
+  }
+  get name () {
+    return this.constructor.name
+  }
+}
+
+module.exports = {
+  RedisError,
+  ParserError,
+  ReplyError
+}

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "redis-errors",
+  "version": "1.0.0",
+  "description": "Error classes used in node_redis",
+  "main": "index.js",
+  "scripts": {
+    "test": "npm run coverage",
+    "lint": "standard --fix",
+    "posttest": "npm run lint && npm run coverage:check",
+    "coverage": "node ./node_modules/istanbul/lib/cli.js cover --preserve-comments ./node_modules/mocha/bin/_mocha -- -R spec",
+    "coverage:check": "node ./node_modules/istanbul/lib/cli.js check-coverage --branch 100 --statement 100"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NodeRedis/node-redis-parser.git"
+  },
+  "keywords": [
+    "redis",
+    "javascript",
+    "node",
+    "error"
+  ],
+  "engines": {
+    "node": ">=4"
+  },
+  "devDependencies": {
+    "buffer-from": "^0.1.1",
+    "istanbul": "^0.4.0",
+    "mocha": "^3.1.2",
+    "standard": "^10.0.0"
+  },
+  "author": "Ruben Bridgewater",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/NodeRedis/redis-errors/issues"
+  },
+  "homepage": "https://github.com/NodeRedis/redis-errors#readme",
+  "directories": {
+    "test": "test",
+    "lib": "lib"
+  }
+}

test/errors.spec.js

@@ -0,0 +1,24 @@
+'use strict'
+
+/* eslint-env mocha */
+
+const assert = require('assert')
+const bufferFrom = require('buffer-from')
+const errors = require('../')
+const ReplyError = errors.ReplyError
+const ParserError = errors.ParserError
+const RedisError = errors.RedisError
+
+describe('errors', function () {
+  it('errors should have a stack trace with error message', function () {
+    const err1 = new RedisError('test')
+    const err2 = new ReplyError('test')
+    const err3 = new ParserError('test', bufferFrom(''), 0)
+    assert(err1.stack)
+    assert(err2.stack)
+    assert(err3.stack)
+    assert(/RedisError: test/.test(err1.stack))
+    assert(/ReplyError: test/.test(err2.stack))
+    assert(/ParserError: test/.test(err3.stack))
+  })
+})