fasterror - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

index.js

@@ -1,22 +0,25 @@
-var _ = require('underscore');
+var util = require('util');
 
-module.exports = function(type, defaults) {
-    if (typeof defaults === 'string' ||
-        typeof defaults === 'number') defaults = { code: defaults };
+module.exports = fastErrorFactory;
 
-    function FastError(message, options) {
-    if (typeof options === 'string' ||
-        typeof options === 'number') options = { code: options };
-      Error.call(this);
-      Error.captureStackTrace(this, arguments.callee);
+function fastErrorFactory(name, defaults) {
+  function FastError() {
+    this.message = util.format.apply(null, arguments);
+    this.name = name;
+    Error.captureStackTrace(this, arguments.callee);
+  }
 
-      this.name = type;
-      this.constructor.name = type;
-      this.message = message || '';
+  FastError.prototype = Object.create(Error.prototype, {
+    constructor: { value: FastError }
+  });
 
-      _(this).chain().extend(defaults).extend(options);
+  if (typeof defaults === 'string' || typeof defaults === 'number') {
+    FastError.prototype.code = defaults
+  } else if (typeof defaults === 'object') {
+    for (var key in defaults) {
+      FastError.prototype[key] = defaults[key];
     }
-    FastError.prototype.__proto__ = Error.prototype;
+  }
 
-    return FastError;
-};
+  return FastError;
+}

package.json

 {
   "name": "fasterror",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Quickly create custom error objects.",
@@ -10,3 +10,3 @@ "main": "index.js",
   "scripts": {
-    "test": "mocha"
+    "test": "nyc tape test/*.js"
   },
@@ -17,7 +17,5 @@ "repository": "",
   "devDependencies": {
-    "mocha": "~1.17.1"
-  },
-  "dependencies": {
-    "underscore": "~1.5.2"
+    "nyc": "^3.2.2",
+    "tape": "^4.2.2"
   }
 }

README.md

@@ -14,10 +14,12 @@ fasterror
 argument is the name of the desired custom error object. The second is an object
-containing keys that will decoate any errors created with the resulting object.
+containing keys that will decorate any errors created with the resulting object.
 
 ```
-var err = new MyError('Failed to load user', {reason: 'missing', code: 2});
+var username = 'jsmith';
+var err = new MyError('Failed to load user %s', username);
 ```
 
-Create new errors with the resulting object. The first argument is the error
-message. The second is an object containing keys that will decorate the error,
-overriding any keys set by the factory.
+Create new errors with the resulting class. The error created will perform string
+interpolation on the arguments passed and set the resulting value as `err.message`.
+See [node.js documentation](https://nodejs.org/docs/v0.10.40/api/util.html#util_util_format_format)
+for interpolation details.

test/error.test.js

@@ -1,69 +0,59 @@
-var assert = require('assert');
 var fasterror = require('../index');
+var test = require('tape');
 
-describe('error factory', function() {
-    it('should make an error constructor', function() {
-        var MyError = fasterror('MyError', 'code');
-        assert.equal(typeof MyError, 'function');
-    });
+test('[error factory] should make an error constructor', function(assert) {
+    var MyError = fasterror('MyError', { code: 'code' });
+    assert.equal(typeof MyError, 'function');
+    assert.end();
 });
 
-describe('error constructor', function() {
-    it('should make a error object that works with instanceof and typeof', function() {
-        var MyError = fasterror('MyError', 'code');
-        var err = new MyError();
-        assert(err instanceof MyError);
-        assert(err instanceof Error);
-        assert.equal(typeof err, 'object');
-    });
-    it('should set .name and .message properly', function() {
-        var MyError = fasterror('MyError', 'code');
-        var err = new MyError('test');
-        assert.equal(err.name, 'MyError');
-        assert.equal(err.message, 'test');
-    });
-    it('should set default properties from second argument if it is an object', function() {
-        var MyError = fasterror('MyError', {code: 123, foo: 'bar'});
-        var err = new MyError();
-        assert.equal(err.code, 123);
-        assert.equal(err.foo, 'bar');
-    });
-    it('should set default code if second argument is a string', function() {
-        var MyError = fasterror('MyError', 'ENOENT');
-        var err = new MyError();
-        assert.equal(err.code, 'ENOENT');
-    });
-    it('should set default code if second argument is a number', function() {
-        var MyError = fasterror('MyError', 123);
-        var err = new MyError();
-        assert.equal(err.code, 123);
-    });
+
+test('[error constructor] should make a error object that works with instanceof and typeof', function(assert) {
+    var MyError = fasterror('MyError', { code: 'code' });
+    var err = new MyError();
+    assert.ok(err instanceof MyError);
+    assert.ok(err instanceof Error);
+    assert.equal(typeof err, 'object');
+    assert.end();
 });
+test('[error constructor] should set .name and .message properly', function(assert) {
+    var MyError = fasterror('MyError', { code: 'code' });
+    var err = new MyError('test');
+    assert.equal(err.name, 'MyError');
+    assert.equal(err.message, 'test');
+    assert.end();
+});
+test('[error constructor] should set default properties from second argument if it is an object', function(assert) {
+    var MyError = fasterror('MyError', {code: 123, foo: 'bar'});
+    var err = new MyError();
+    assert.equal(err.code, 123);
+    assert.equal(err.foo, 'bar');
+    assert.end();
+});
+test('[error constructor] should set default code if second argument is a string', function(assert) {
+    var MyError = fasterror('MyError', 'ENOENT');
+    var err = new MyError();
+    assert.equal(err.code, 'ENOENT');
+    assert.end();
+});
+test('[error constructor] should set default code if second argument is a number', function(assert) {
+    var MyError = fasterror('MyError', 123);
+    var err = new MyError();
+    assert.equal(err.code, 123);
+    assert.end();
+});
 
-describe('error object', function() {
-    it('should set properties from second argument if it is an object', function() {
-        var MyError = fasterror('MyError', {code: 123});
-        var err = new MyError();
-        assert.equal(err.code, 123);
-    });
-    it('should set code if second argument is a string', function() {
-        var MyError = fasterror('MyError');
-        var err = new MyError('test', 'ENOENT');
-        assert.equal(err.code, 'ENOENT');
-    });
-    it('should set code if second argument is a number', function() {
-        var MyError = fasterror('MyError');
-        var err = new MyError('test', 123);
-        assert.equal(err.code, 123);
-    });
-    it('should merge with defaults from constructor', function() {
-        var MyError = fasterror('MyError', {code: 123, foo: 'bar'});
-        var err = new MyError('test', 'ENOENT');
-        assert.equal(err.code, 'ENOENT');
-        assert.equal(err.foo, 'bar');
-        var err2 = new MyError('test', {foo: 'baz', bar: 'bin'});
-        assert.equal(err2.code, 123);
-        assert.equal(err2.foo, 'baz');
-        assert.equal(err2.bar, 'bin');
-    });
+test('[error object] should perform string interpolation on provided arguments', function(assert) {
+    var MyError = fasterror('MyError');
+    var err = new MyError('%s, %j', 'bacon', { lettuce: true, tomato: true });
+    assert.equal(err.message, 'bacon, {"lettuce":true,"tomato":true}');
+    assert.end();
 });
+
+test('[error object] should merge with defaults from constructor', function(assert) {
+    var MyError = fasterror('MyError', {code: 123, foo: 'bar'});
+    var err = new MyError('test');
+    assert.equal(err.code, 123);
+    assert.equal(err.foo, 'bar');
+    assert.end();
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Dependency count

0

decreased by-100%

Number of package files

6

increased by20%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

25

increased by8.7%

Worsened metrics

Total package byte prevSize

4229

decreased by-8.18%

Dev dependency count

2

increased by100%

Lines of code

74

decreased by-10.84%

Dependency changes

• - Removedunderscore@~1.5.2

• - Removedunderscore@1.5.2(transitive)