Package Exports
- plugin-error
- plugin-error/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (plugin-error) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
plugin-error
Error handling for Vinyl plugins.
Usage
var PluginError = require('plugin-error');
var err = new PluginError('test', {
message: 'something broke',
});
var err = new PluginError({
plugin: 'test',
message: 'something broke',
});
var err = new PluginError('test', 'something broke');
var err = new PluginError('test', 'something broke', { showStack: true });
var existingError = new Error('OMG');
var err = new PluginError('test', existingError, { showStack: true });
API
new PluginError(pluginName, message[, options])
Error constructor that takes:
pluginName
- aString
that should be the module name of your pluginmessage
- aString
message or an existingError
objectoptions
- anObject
of your options
Behavior:
- By default the stack will not be shown. Set
options.showStack
to true if you think the stack is important for your error. - If you pass an error object as the message the stack will be pulled from that, otherwise one will be created.
- If you pass in a custom stack string you need to include the message along with that.
- Error properties will be included in
err.toString()
, but may be omitted by including{ showProperties: false }
in the options.
License
MIT