makeerror - npm Package Compare versions

Comparing version 1.0.7 to 1.0.8

package.json

 {
   "name": "makeerror",
   "description": "A library to make errors.",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "author": "Naitik Shah <[e-mail]>",
@@ -6,0 +6,0 @@ "main": "lib/makeerror",

readme.md

 makeerror
 =========
 
-A library to make errors. Makes an Error constructor function with the
-signature:
+A library to make errors.
 
+
+Basics
+------
+
+Makes an Error constructor function with the signature below. All arguments are
+optional, and if the first argument is not a `String`, it will be assumed to be
+`data`:
+
 ```javascript
@@ -25,7 +32,47 @@ function(message, data)
 ```javascript
+er instanceof UnknownFileTypeError
 er instanceof Error
-er instanceof UnknownFileTypeError
 ```
 
-You can also do `var er = new UnknownFileTypeError()` if you really like the
-`new` keyword.
+
+Templatized Error Messages
+--------------------------
+
+There is support for simple string substitutions like:
+
+```javascript
+var makeError = require('makeerror')
+var UnknownFileTypeError = makeError(
+  'UnknownFileTypeError',
+  'The specified type "{type}" is not known.'
+)
+var er = UnknownFileTypeError({ type: 'bmp' })
+```
+
+Now `er.message` or `er.toString()` will return `'The specified type "bmp" is
+not known.'`.
+
+
+Prototype Hierarchies
+---------------------
+
+You can create simple hierarchies as well using the `prototype` chain:
+
+```javascript
+var makeError = require('makeerror')
+var ParentError = makeError('ParentError')
+var ChildError = makeError(
+  'ChildError',
+  'The child error.',
+  { proto: ParentError() }
+)
+var er = ChildError()
+```
+
+`er` will have a prototype chain that ensures:
+
+```javascript
+er instanceof ChildError
+er instanceof ParentError
+er instanceof Error
+```

No alert changes

Improved metrics

Number of lines in readme file

78

increased by151.61%

Worsened metrics

Total package byte prevSize

4425

decreased by-59.87%

Number of package files

3

decreased by-50%

Lines of code

75

decreased by-65.44%

No dependency changes