1.0.0 • Published 3 months ago
@adorade/plugin-error v1.0.0
Plugin Error
Error handling for Gulp plugins with ESM support.
This package is pure ESM. Please read this.
Installation
npm install @adorade/plugin-error --save-dev
# Or with yarn:
yarn add @adorade/plugin-error --dev
Usage
import PluginError from '@adorade/plugin-error';
const err = new PluginError('test', {
message: 'something broke',
});
const err = new PluginError({
plugin: 'test',
message: 'something broke',
});
const err = new PluginError('test', 'something broke');
const err = new PluginError('test', 'something broke', {
showStack: true, // false (default) | true
showProperties: false // true (default) | false
});
const existingError = new Error('OMG');
const err = new PluginError('test', existingError, { showStack: true });
API
new PluginError(plugin, message[, options])
Error constructor that takes:
plugin
- 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
See the MIT LICENSE file for license rights and limitations.
1.0.0
3 months ago