Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Added description for options.properties on PluginError #55

Closed
wants to merge 1 commit into from
Closed

Added description for options.properties on PluginError #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -109,6 +109,7 @@ gulp.src('stuff/*.js')
- 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 in as the message the stack will be pulled from that, otherwise one will be created.
- Note that if you pass in a custom stack string you need to include the message along with that.
- By default all properties on original errors will be copied to the `PluginError`. However, properties can be white listed via `options.properties` of type `Array[String]`. After, the original error properties have been copied then any property on the `options` that is included in the `options.properties` will override or be copied to the `PluginError`.

These are all acceptable forms of instantiation:

Expand Down